Class: Fastly::LoggingCloudfilesAdditional

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoggingCloudfilesAdditional

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
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
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 96

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

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

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

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

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

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

Instance Attribute Details

#access_keyObject

Your Cloud Files account access key.



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

def access_key
  @access_key
end

#bucket_nameObject

The name of your Cloud Files container.



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

def bucket_name
  @bucket_name
end

#pathObject

The path to upload logs to.



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

def path
  @path
end

#public_keyObject

A PGP public key that Fastly will use to encrypt your log files before writing them to disk.



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

def public_key
  @public_key
end

#regionObject

The region to stream logs to.



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

def region
  @region
end

#userObject

The username for your Cloud Files account.



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

def user
  @user
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



69
70
71
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
66
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 57

def self.attribute_map
  {
    :'access_key' => :'access_key',
    :'bucket_name' => :'bucket_name',
    :'path' => :'path',
    :'region' => :'region',
    :'public_key' => :'public_key',
    :'user' => :'user'
  }
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



191
192
193
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 191

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

.fastly_nullableObject

List of attributes with nullable: true



86
87
88
89
90
91
92
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 86

def self.fastly_nullable
  Set.new([
    :'path',
    :'region',
    :'public_key',
  ])
end

.fastly_typesObject

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 74

def self.fastly_types
  {
    :'access_key' => :'String',
    :'bucket_name' => :'String',
    :'path' => :'String',
    :'region' => :'String',
    :'public_key' => :'String',
    :'user' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



165
166
167
168
169
170
171
172
173
174
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_key == o.access_key &&
      bucket_name == o.bucket_name &&
      path == o.path &&
      region == o.region &&
      public_key == o.public_key &&
      user == o.user
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



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
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 221

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



292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 292

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 198

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


178
179
180
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 178

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



184
185
186
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 184

def hash
  [access_key, bucket_name, path, region, public_key, user].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



140
141
142
143
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 140

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



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

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



274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 274

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



262
263
264
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 262

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



147
148
149
150
151
# File 'lib/fastly/models/logging_cloudfiles_additional.rb', line 147

def valid?
  region_validator = EnumAttributeValidator.new('String', ["DFW", "ORD", "IAD", "LON", "SYD", "HKG", "null"])
  return false unless region_validator.valid?(@region)
  true
end