Class: Fastly::LoggingElasticsearchResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoggingElasticsearchResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 190

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingElasticsearchResponse` 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::LoggingElasticsearchResponse`. 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?(:'tls_ca_cert')
    self.tls_ca_cert = attributes[:'tls_ca_cert']
  else
    self.tls_ca_cert = 'null'
  end

  if attributes.key?(:'tls_client_cert')
    self.tls_client_cert = attributes[:'tls_client_cert']
  else
    self.tls_client_cert = 'null'
  end

  if attributes.key?(:'tls_client_key')
    self.tls_client_key = attributes[:'tls_client_key']
  else
    self.tls_client_key = 'null'
  end

  if attributes.key?(:'tls_hostname')
    self.tls_hostname = attributes[:'tls_hostname']
  else
    self.tls_hostname = 'null'
  end

  if attributes.key?(:'request_max_entries')
    self.request_max_entries = attributes[:'request_max_entries']
  else
    self.request_max_entries = 0
  end

  if attributes.key?(:'request_max_bytes')
    self.request_max_bytes = attributes[:'request_max_bytes']
  else
    self.request_max_bytes = 0
  end

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

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

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

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

  if attributes.key?(:'password')
    self.password = attributes[:'password']
  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_at ⇒ Object

Date and time in ISO 8601 format.



65
66
67
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 65

def created_at
  @created_at
end

#deleted_at ⇒ Object

Date and time in ISO 8601 format.



68
69
70
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 68

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 Elasticsearch can ingest.



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

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



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

def format_version
  @format_version
end

#index ⇒ Object

The name of the Elasticsearch index to send documents (logs) to. The index must follow the Elasticsearch [index format rules](www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html). We support [strftime](www.man7.org/linux/man-pages/man3/strftime.3.html) interpolated variables inside braces prefixed with a pound symbol. For example, ‘#%F` will interpolate as `YYYY-MM-DD` with today’s date.



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

def index
  @index
end

#name ⇒ Object

The name for the real-time logging configuration.



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

def name
  @name
end

#password ⇒ Object

Basic Auth password.



62
63
64
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 62

def password
  @password
end

#pipeline ⇒ Object

The ID of the Elasticsearch ingest pipeline to apply pre-process transformations to before indexing. Learn more about creating a pipeline in the [Elasticsearch docs](www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html).



56
57
58
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 56

def pipeline
  @pipeline
end

#placement ⇒ Object

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_elasticsearch_response.rb', line 20

def placement
  @placement
end

#request_max_bytes ⇒ Object

The maximum number of bytes sent in one request. Defaults ‘0` for unbounded.



47
48
49
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 47

def request_max_bytes
  @request_max_bytes
end

#request_max_entries ⇒ Object

The maximum number of logs sent in one request. Defaults ‘0` for unbounded.



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

def request_max_entries
  @request_max_entries
end

#response_condition ⇒ Object

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



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

def response_condition
  @response_condition
end

#service_id ⇒ Object

Returns the value of attribute service_id.



73
74
75
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 73

def service_id
  @service_id
end

#tls_ca_cert ⇒ Object

A secure certificate to authenticate a server with. Must be in PEM format.



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

def tls_ca_cert
  @tls_ca_cert
end

#tls_client_cert ⇒ Object

The client certificate used to make authenticated requests. Must be in PEM format.



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

def tls_client_cert
  @tls_client_cert
end

#tls_client_key ⇒ Object

The client private key used to make authenticated requests. Must be in PEM format.



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

def tls_client_key
  @tls_client_key
end

#tls_hostname ⇒ Object

The hostname to verify the server’s certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported.



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

def tls_hostname
  @tls_hostname
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



71
72
73
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 71

def updated_at
  @updated_at
end

#url ⇒ Object

The URL to stream logs to. Must use HTTPS.



53
54
55
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 53

def url
  @url
end

#user ⇒ Object

Basic Auth username.



59
60
61
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 59

def user
  @user
end

#version ⇒ Object

Returns the value of attribute version.



75
76
77
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 75

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



127
128
129
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 127

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 100

def self.attribute_map
  {
    :'name' => :'name',
    :'placement' => :'placement',
    :'response_condition' => :'response_condition',
    :'format' => :'format',
    :'format_version' => :'format_version',
    :'tls_ca_cert' => :'tls_ca_cert',
    :'tls_client_cert' => :'tls_client_cert',
    :'tls_client_key' => :'tls_client_key',
    :'tls_hostname' => :'tls_hostname',
    :'request_max_entries' => :'request_max_entries',
    :'request_max_bytes' => :'request_max_bytes',
    :'index' => :'index',
    :'url' => :'url',
    :'pipeline' => :'pipeline',
    :'user' => :'user',
    :'password' => :'password',
    :'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



382
383
384
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 382

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 177

def self.fastly_all_of
  [
  :'LoggingCommonResponse',
  :'LoggingElasticsearchAdditional',
  :'LoggingRequestCapsCommon',
  :'LoggingTlsCommon',
  :'ServiceIdAndVersionString',
  :'Timestamps'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 159

def self.fastly_nullable
  Set.new([
    :'placement',
    :'response_condition',
    :'tls_ca_cert',
    :'tls_client_cert',
    :'tls_client_key',
    :'tls_hostname',
    :'pipeline',
    :'user',
    :'password',
    :'created_at',
    :'deleted_at',
    :'updated_at',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 132

def self.fastly_types
  {
    :'name' => :'String',
    :'placement' => :'String',
    :'response_condition' => :'String',
    :'format' => :'String',
    :'format_version' => :'String',
    :'tls_ca_cert' => :'String',
    :'tls_client_cert' => :'String',
    :'tls_client_key' => :'String',
    :'tls_hostname' => :'String',
    :'request_max_entries' => :'Integer',
    :'request_max_bytes' => :'Integer',
    :'index' => :'String',
    :'url' => :'String',
    :'pipeline' => :'String',
    :'user' => :'String',
    :'password' => :'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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 341

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 &&
      tls_ca_cert == o.tls_ca_cert &&
      tls_client_cert == o.tls_client_cert &&
      tls_client_key == o.tls_client_key &&
      tls_hostname == o.tls_hostname &&
      request_max_entries == o.request_max_entries &&
      request_max_bytes == o.request_max_bytes &&
      index == o.index &&
      url == o.url &&
      pipeline == o.pipeline &&
      user == o.user &&
      password == o.password &&
      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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 412

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



483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 483

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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 389

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


369
370
371
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 369

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



375
376
377
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 375

def hash
  [name, placement, response_condition, format, format_version, tls_ca_cert, tls_client_cert, tls_client_key, tls_hostname, request_max_entries, request_max_bytes, index, url, pipeline, user, password, 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



304
305
306
307
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 304

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



459
460
461
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 459

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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 465

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



453
454
455
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 453

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



311
312
313
314
315
316
317
 
# File 'lib/fastly/models/logging_elasticsearch_response.rb', line 311

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