Class: Fastly::LoggingHoneycombResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/logging_honeycomb_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoggingHoneycombResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 136

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingHoneycombResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::LoggingHoneycombResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'placement')
    self.placement = attributes[:'placement']
  end

  if attributes.key?(:'response_condition')
    self.response_condition = attributes[:'response_condition']
  end

  if attributes.key?(:'format')
    self.format = attributes[:'format']
  end

  if attributes.key?(:'format_version')
    self.format_version = attributes[:'format_version']
  else
    self.format_version = '2'
  end

  if attributes.key?(:'dataset')
    self.dataset = attributes[:'dataset']
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'deleted_at')
    self.deleted_at = attributes[:'deleted_at']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.key?(:'service_id')
    self.service_id = attributes[:'service_id']
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#created_atObject

Date and time in ISO 8601 format.



38
39
40
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 38

def created_at
  @created_at
end

#datasetObject

The Honeycomb Dataset you want to log to.



32
33
34
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 32

def dataset
  @dataset
end

#deleted_atObject

Date and time in ISO 8601 format.



41
42
43
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 41

def deleted_at
  @deleted_at
end

#formatObject

A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Honeycomb can ingest.



26
27
28
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 26

def format
  @format
end

#format_versionObject

The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in ‘vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.



29
30
31
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 29

def format_version
  @format_version
end

#nameObject

The name for the real-time logging configuration.



17
18
19
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 17

def name
  @name
end

#placementObject

Where in the generated VCL the logging call should be placed. If not set, endpoints with ‘format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.



20
21
22
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 20

def placement
  @placement
end

#response_conditionObject

The name of an existing condition in the configured endpoint, or leave blank to always execute.



23
24
25
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 23

def response_condition
  @response_condition
end

#service_idObject

Returns the value of attribute service_id.



46
47
48
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 46

def service_id
  @service_id
end

#tokenObject

The Write Key from the Account page of your Honeycomb account.



35
36
37
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 35

def token
  @token
end

#updated_atObject

Date and time in ISO 8601 format.



44
45
46
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 44

def updated_at
  @updated_at
end

#versionObject

Returns the value of attribute version.



48
49
50
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 48

def version
  @version
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



91
92
93
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 73

def self.attribute_map
  {
    :'name' => :'name',
    :'placement' => :'placement',
    :'response_condition' => :'response_condition',
    :'format' => :'format',
    :'format_version' => :'format_version',
    :'dataset' => :'dataset',
    :'token' => :'token',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'service_id' => :'service_id',
    :'version' => :'version'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



271
272
273
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 271

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_all_ofObject

List of class defined in allOf (OpenAPI v3)



125
126
127
128
129
130
131
132
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 125

def self.fastly_all_of
  [
  :'LoggingCommonResponse',
  :'LoggingHoneycombAdditional',
  :'ServiceIdAndVersionString',
  :'Timestamps'
  ]
end

.fastly_nullableObject

List of attributes with nullable: true



114
115
116
117
118
119
120
121
122
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 114

def self.fastly_nullable
  Set.new([
    :'placement',
    :'response_condition',
    :'created_at',
    :'deleted_at',
    :'updated_at',
  ])
end

.fastly_typesObject

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 96

def self.fastly_types
  {
    :'name' => :'String',
    :'placement' => :'String',
    :'response_condition' => :'String',
    :'format' => :'String',
    :'format_version' => :'String',
    :'dataset' => :'String',
    :'token' => :'String',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'service_id' => :'String',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      placement == o.placement &&
      response_condition == o.response_condition &&
      format == o.format &&
      format_version == o.format_version &&
      dataset == o.dataset &&
      token == o.token &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      service_id == o.service_id &&
      version == o.version
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 301

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 372

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 278

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


258
259
260
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 258

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



264
265
266
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 264

def hash
  [name, placement, response_condition, format, format_version, dataset, token, created_at, deleted_at, updated_at, service_id, version].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



202
203
204
205
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 202

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



348
349
350
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 348

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 354

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



342
343
344
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 342

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



209
210
211
212
213
214
215
# File 'lib/fastly/models/logging_honeycomb_response.rb', line 209

def valid?
  placement_validator = EnumAttributeValidator.new('String', ["none", "waf_debug", "null"])
  return false unless placement_validator.valid?(@placement)
  format_version_validator = EnumAttributeValidator.new('String', ["1", "2"])
  return false unless format_version_validator.valid?(@format_version)
  true
end