Class: Fastly::LoggingKinesisResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoggingKinesisResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 146

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingKinesisResponse` 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::LoggingKinesisResponse`. 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?(:'format')
    self.format = attributes[:'format']
  else
    self.format = '{\"timestamp\":\"%{begin:%Y-%m-%dT%H:%M:%S}t\",\"time_elapsed\":\"%{time.elapsed.usec}V\",\"is_tls\":\"%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V\",\"client_ip\":\"%{req.http.Fastly-Client-IP}V\",\"geo_city\":\"%{client.geo.city}V\",\"geo_country_code\":\"%{client.geo.country_code}V\",\"request\":\"%{req.request}V\",\"host\":\"%{req.http.Fastly-Orig-Host}V\",\"url\":\"%{json.escape(req.url)}V\",\"request_referer\":\"%{json.escape(req.http.Referer)}V\",\"request_user_agent\":\"%{json.escape(req.http.User-Agent)}V\",\"request_accept_language\":\"%{json.escape(req.http.Accept-Language)}V\",\"request_accept_charset\":\"%{json.escape(req.http.Accept-Charset)}V\",\"cache_status\":\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\"}'
  end

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

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

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

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

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

  if attributes.key?(:'format_version')
    self.format_version = attributes[:'format_version']
  else
    self.format_version = '2'
  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

#access_key ⇒ Object

The access key associated with the target Amazon Kinesis stream. Not required if ‘iam_role` is specified.



33
34
35
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 33

def access_key
  @access_key
end

#created_at ⇒ Object

Date and time in ISO 8601 format.



42
43
44
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 42

def created_at
  @created_at
end

#deleted_at ⇒ Object

Date and time in ISO 8601 format.



45
46
47
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 45

def deleted_at
  @deleted_at
end

#format ⇒ Object

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



22
23
24
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 22

def format
  @format
end

#format_version ⇒ Object

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`.



39
40
41
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 39

def format_version
  @format_version
end

#iam_role ⇒ Object

The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if ‘access_key` and `secret_key` are provided.



36
37
38
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 36

def iam_role
  @iam_role
end

#name ⇒ Object

The name for the real-time logging configuration.



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

def name
  @name
end

#placement ⇒ Object

Returns the value of attribute placement.



19
20
21
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 19

def placement
  @placement
end

#region ⇒ Object

Returns the value of attribute region.



27
28
29
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 27

def region
  @region
end

#secret_key ⇒ Object

The secret key associated with the target Amazon Kinesis stream. Not required if ‘iam_role` is specified.



30
31
32
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 30

def secret_key
  @secret_key
end

#service_id ⇒ Object

Returns the value of attribute service_id.



50
51
52
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 50

def service_id
  @service_id
end

#topic ⇒ Object

The Amazon Kinesis stream to send logs to. Required.



25
26
27
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 25

def topic
  @topic
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



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

def updated_at
  @updated_at
end

#version ⇒ Object

Returns the value of attribute version.



52
53
54
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 52

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 77

def self.attribute_map
  {
    :'name' => :'name',
    :'placement' => :'placement',
    :'format' => :'format',
    :'topic' => :'topic',
    :'region' => :'region',
    :'secret_key' => :'secret_key',
    :'access_key' => :'access_key',
    :'iam_role' => :'iam_role',
    :'format_version' => :'format_version',
    :'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



281
282
283
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 281

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



135
136
137
138
139
140
141
142
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 135

def self.fastly_all_of
  [
  :'LoggingFormatVersionString',
  :'LoggingKinesisAdditional',
  :'ServiceIdAndVersionString',
  :'Timestamps'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 122

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

.fastly_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 102

def self.fastly_types
  {
    :'name' => :'String',
    :'placement' => :'LoggingPlacement',
    :'format' => :'String',
    :'topic' => :'String',
    :'region' => :'AwsRegion',
    :'secret_key' => :'String',
    :'access_key' => :'String',
    :'iam_role' => :'String',
    :'format_version' => :'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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      placement == o.placement &&
      format == o.format &&
      topic == o.topic &&
      region == o.region &&
      secret_key == o.secret_key &&
      access_key == o.access_key &&
      iam_role == o.iam_role &&
      format_version == o.format_version &&
      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



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
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 311

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 382

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 288

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


268
269
270
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 274

def hash
  [name, placement, format, topic, region, secret_key, access_key, iam_role, format_version, created_at, deleted_at, updated_at, service_id, version].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



222
223
224
225
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 222

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



358
359
360
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 358

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 364

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



352
353
354
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 352

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



229
230
231
232
233
 
# File 'lib/fastly/models/logging_kinesis_response.rb', line 229

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