Class: Fastly::LoggingHttpsAdditional

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoggingHttpsAdditional

Initializes the object

Parameters:

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

    Model attributes in the form of hash



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
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
 
# File 'lib/fastly/models/logging_https_additional.rb', line 115

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

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

  if attributes.key?(:'message_type')
    self.message_type = attributes[:'message_type']
  else
    self.message_type = 'classic'
  end

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

  if attributes.key?(:'method')
    self.method = attributes[:'method']
  else
    self.method = 'POST'
  end

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

  if attributes.key?(:'format')
    self.format = attributes[:'format']
  else
    self.format = '%h %l %u %t \"%r\" %>s %b'
  end
end

Instance Attribute Details

#content_type ⇒ Object

Content type of the header sent with the request.



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

def content_type
  @content_type
end

#format ⇒ Object

A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats).



43
44
45
 
# File 'lib/fastly/models/logging_https_additional.rb', line 43

def format
  @format
end

#header_name ⇒ Object

Name of the custom header sent with the request.



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

def header_name
  @header_name
end

#header_value ⇒ Object

Value of the custom header sent with the request.



34
35
36
 
# File 'lib/fastly/models/logging_https_additional.rb', line 34

def header_value
  @header_value
end

#json_format ⇒ Object

Enforces valid JSON formatting for log entries.



40
41
42
 
# File 'lib/fastly/models/logging_https_additional.rb', line 40

def json_format
  @json_format
end

#message_type ⇒ Object

Returns the value of attribute message_type.



31
32
33
 
# File 'lib/fastly/models/logging_https_additional.rb', line 31

def message_type
  @message_type
end

#method ⇒ Object

HTTP method used for request.



37
38
39
 
# File 'lib/fastly/models/logging_https_additional.rb', line 37

def method
  @method
end

#request_max_bytes ⇒ Object

The maximum number of bytes sent in one request. Defaults ‘0` (100MB).



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

def request_max_bytes
  @request_max_bytes
end

#request_max_entries ⇒ Object

The maximum number of logs sent in one request. Defaults ‘0` (10k).



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

def request_max_entries
  @request_max_entries
end

#url ⇒ Object

The URL to send logs to. Must use HTTPS. Required.



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/fastly/models/logging_https_additional.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/fastly/models/logging_https_additional.rb', line 68

def self.attribute_map
  {
    :'url' => :'url',
    :'request_max_entries' => :'request_max_entries',
    :'request_max_bytes' => :'request_max_bytes',
    :'content_type' => :'content_type',
    :'header_name' => :'header_name',
    :'message_type' => :'message_type',
    :'header_value' => :'header_value',
    :'method' => :'method',
    :'json_format' => :'json_format',
    :'format' => :'format'
  }
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



254
255
256
 
# File 'lib/fastly/models/logging_https_additional.rb', line 254

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
109
110
111
 
# File 'lib/fastly/models/logging_https_additional.rb', line 105

def self.fastly_nullable
  Set.new([
    :'content_type',
    :'header_name',
    :'header_value',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/fastly/models/logging_https_additional.rb', line 89

def self.fastly_types
  {
    :'url' => :'String',
    :'request_max_entries' => :'Integer',
    :'request_max_bytes' => :'Integer',
    :'content_type' => :'String',
    :'header_name' => :'String',
    :'message_type' => :'LoggingMessageType',
    :'header_value' => :'String',
    :'method' => :'String',
    :'json_format' => :'String',
    :'format' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/fastly/models/logging_https_additional.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      request_max_entries == o.request_max_entries &&
      request_max_bytes == o.request_max_bytes &&
      content_type == o.content_type &&
      header_name == o.header_name &&
      message_type == o.message_type &&
      header_value == o.header_value &&
      method == o.method &&
      json_format == o.json_format &&
      format == o.format
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/fastly/models/logging_https_additional.rb', line 284

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



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

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/fastly/models/logging_https_additional.rb', line 261

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


241
242
243
 
# File 'lib/fastly/models/logging_https_additional.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/fastly/models/logging_https_additional.rb', line 247

def hash
  [url, request_max_entries, request_max_bytes, content_type, header_name, message_type, header_value, method, json_format, format].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



187
188
189
190
 
# File 'lib/fastly/models/logging_https_additional.rb', line 187

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



331
332
333
 
# File 'lib/fastly/models/logging_https_additional.rb', line 331

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/fastly/models/logging_https_additional.rb', line 337

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



325
326
327
 
# File 'lib/fastly/models/logging_https_additional.rb', line 325

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



194
195
196
197
198
199
200
 
# File 'lib/fastly/models/logging_https_additional.rb', line 194

def valid?
  method_validator = EnumAttributeValidator.new('String', ["POST", "PUT"])
  return false unless method_validator.valid?(@method)
  json_format_validator = EnumAttributeValidator.new('String', ["0", "1", "2"])
  return false unless json_format_validator.valid?(@json_format)
  true
end