Class: Fastly::LoggingS3Additional

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoggingS3Additional

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_key ⇒ Object

The access key for your S3 account. Not required if ‘iam_role` is provided.



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

def access_key
  @access_key
end

#acl ⇒ Object

The access control list (ACL) specific request header. See the AWS documentation for [Access Control List (ACL) Specific Request Headers](docs.aws.amazon.com/AmazonS3/latest/API/mpUploadInitiate.html#initiate-mpu-acl-specific-request-headers) for more information.



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

def acl
  @acl
end

#bucket_name ⇒ Object

The bucket name for S3 account.



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

def bucket_name
  @bucket_name
end

#domain ⇒ Object

The domain of the Amazon S3 endpoint.



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

def domain
  @domain
end

#file_max_bytes ⇒ Object

The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)



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

def file_max_bytes
  @file_max_bytes
end

#iam_role ⇒ Object

The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if ‘access_key` and `secret_key` are provided.



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

def iam_role
  @iam_role
end

#path ⇒ Object

The path to upload logs to.



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

def path
  @path
end

#public_key ⇒ Object

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



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

def public_key
  @public_key
end

#redundancy ⇒ Object

The S3 redundancy level.



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

def redundancy
  @redundancy
end

#secret_key ⇒ Object

The secret key for your S3 account. Not required if ‘iam_role` is provided.



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

def secret_key
  @secret_key
end

#server_side_encryption ⇒ Object

Set this to ‘AES256` or `aws:kms` to enable S3 Server Side Encryption.



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

def server_side_encryption
  @server_side_encryption
end

#server_side_encryption_kms_key_id ⇒ Object

Optional server-side KMS Key Id. Must be set if ‘server_side_encryption` is set to `aws:kms` or `AES256`.



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

def server_side_encryption_kms_key_id
  @server_side_encryption_kms_key_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 53

def self.attribute_map
  {
    :'access_key' => :'access_key',
    :'acl' => :'acl',
    :'bucket_name' => :'bucket_name',
    :'domain' => :'domain',
    :'iam_role' => :'iam_role',
    :'path' => :'path',
    :'public_key' => :'public_key',
    :'redundancy' => :'redundancy',
    :'secret_key' => :'secret_key',
    :'server_side_encryption_kms_key_id' => :'server_side_encryption_kms_key_id',
    :'server_side_encryption' => :'server_side_encryption',
    :'file_max_bytes' => :'file_max_bytes'
  }
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



243
244
245
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 243

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 94

def self.fastly_nullable
  Set.new([
    :'access_key',
    :'iam_role',
    :'path',
    :'public_key',
    :'redundancy',
    :'secret_key',
    :'server_side_encryption_kms_key_id',
    :'server_side_encryption',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



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

def self.fastly_types
  {
    :'access_key' => :'String',
    :'acl' => :'String',
    :'bucket_name' => :'String',
    :'domain' => :'String',
    :'iam_role' => :'String',
    :'path' => :'String',
    :'public_key' => :'String',
    :'redundancy' => :'String',
    :'secret_key' => :'String',
    :'server_side_encryption_kms_key_id' => :'String',
    :'server_side_encryption' => :'String',
    :'file_max_bytes' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_key == o.access_key &&
      acl == o.acl &&
      bucket_name == o.bucket_name &&
      domain == o.domain &&
      iam_role == o.iam_role &&
      path == o.path &&
      public_key == o.public_key &&
      redundancy == o.redundancy &&
      secret_key == o.secret_key &&
      server_side_encryption_kms_key_id == o.server_side_encryption_kms_key_id &&
      server_side_encryption == o.server_side_encryption &&
      file_max_bytes == o.file_max_bytes
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



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
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 273

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 344

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 250

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


230
231
232
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 236

def hash
  [access_key, acl, bucket_name, domain, iam_role, path, public_key, redundancy, secret_key, server_side_encryption_kms_key_id, server_side_encryption, file_max_bytes].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



183
184
185
186
187
188
189
190
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 183

def list_invalid_properties
  invalid_properties = Array.new
  if !@file_max_bytes.nil? && @file_max_bytes < 1048576
    invalid_properties.push('invalid value for "file_max_bytes", must be greater than or equal to 1048576.')
  end

  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



320
321
322
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 320

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 326

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



314
315
316
 
# File 'lib/fastly/models/logging_s3_additional.rb', line 314

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

def valid?
  return false if !@file_max_bytes.nil? && @file_max_bytes < 1048576
  true
end