Class: Fastly::LoggingS3
- Inherits:
-
Object
- Object
- Fastly::LoggingS3
- Defined in:
- lib/fastly/models/logging_s3.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#access_key ⇒ Object
The access key for your S3 account.
-
#acl ⇒ Object
The access control list (ACL) specific request header.
-
#bucket_name ⇒ Object
The bucket name for S3 account.
-
#compression_codec ⇒ Object
The codec used for compressing your logs.
-
#domain ⇒ Object
The domain of the Amazon S3 endpoint.
-
#format ⇒ Object
A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats).
-
#format_version ⇒ Object
The version of the custom logging format used for the configured endpoint.
-
#gzip_level ⇒ Object
The level of gzip encoding when sending logs (default ‘0`, no compression).
-
#iam_role ⇒ Object
The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3.
-
#message_type ⇒ Object
How the message should be formatted.
-
#name ⇒ Object
The name for the real-time logging configuration.
-
#path ⇒ Object
The path to upload logs to.
-
#period ⇒ Object
How frequently log files are finalized so they can be available for reading (in seconds).
-
#placement ⇒ Object
Where in the generated VCL the logging call should be placed.
-
#public_key ⇒ Object
A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
-
#redundancy ⇒ Object
The S3 redundancy level.
-
#response_condition ⇒ Object
The name of an existing condition in the configured endpoint, or leave blank to always execute.
-
#secret_key ⇒ Object
The secret key for your S3 account.
-
#server_side_encryption ⇒ Object
Set this to ‘AES256` or `aws:kms` to enable S3 Server Side Encryption.
-
#server_side_encryption_kms_key_id ⇒ Object
Optional server-side KMS Key Id.
-
#timestamp_format ⇒ Object
A timestamp format.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.fastly_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3).
-
.fastly_nullable ⇒ Object
List of attributes with nullable: true.
-
.fastly_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ LoggingS3
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ LoggingS3
Initializes the object
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 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 301 302 303 304 |
# File 'lib/fastly/models/logging_s3.rb', line 188 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingS3` 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::LoggingS3`. 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_version') self.format_version = attributes[:'format_version'] else self.format_version = FORMAT_VERSION::v2 end if attributes.key?(:'response_condition') self.response_condition = attributes[:'response_condition'] end if attributes.key?(:'format') self.format = attributes[:'format'] else self.format = '%h %l %u %t \"%r\" %>s %b' end if attributes.key?(:'message_type') self. = attributes[:'message_type'] else self. = 'classic' end if attributes.key?(:'timestamp_format') self. = attributes[:'timestamp_format'] end if attributes.key?(:'period') self.period = attributes[:'period'] else self.period = 3600 end if attributes.key?(:'gzip_level') self.gzip_level = attributes[:'gzip_level'] else self.gzip_level = 0 end if attributes.key?(:'compression_codec') self.compression_codec = attributes[:'compression_codec'] end 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 end |
Instance Attribute Details
#access_key ⇒ Object
The access key for your S3 account. Not required if ‘iam_role` is provided.
47 48 49 |
# File 'lib/fastly/models/logging_s3.rb', line 47 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.
50 51 52 |
# File 'lib/fastly/models/logging_s3.rb', line 50 def acl @acl end |
#bucket_name ⇒ Object
The bucket name for S3 account.
53 54 55 |
# File 'lib/fastly/models/logging_s3.rb', line 53 def bucket_name @bucket_name end |
#compression_codec ⇒ Object
The codec used for compressing your logs. Valid values are ‘zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
44 45 46 |
# File 'lib/fastly/models/logging_s3.rb', line 44 def compression_codec @compression_codec end |
#domain ⇒ Object
The domain of the Amazon S3 endpoint.
56 57 58 |
# File 'lib/fastly/models/logging_s3.rb', line 56 def domain @domain end |
#format ⇒ Object
A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats).
29 30 31 |
# File 'lib/fastly/models/logging_s3.rb', line 29 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`.
23 24 25 |
# File 'lib/fastly/models/logging_s3.rb', line 23 def format_version @format_version end |
#gzip_level ⇒ Object
The level of gzip encoding when sending logs (default ‘0`, no compression). Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
41 42 43 |
# File 'lib/fastly/models/logging_s3.rb', line 41 def gzip_level @gzip_level 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.
59 60 61 |
# File 'lib/fastly/models/logging_s3.rb', line 59 def iam_role @iam_role end |
#message_type ⇒ Object
How the message should be formatted.
32 33 34 |
# File 'lib/fastly/models/logging_s3.rb', line 32 def @message_type end |
#name ⇒ Object
The name for the real-time logging configuration.
17 18 19 |
# File 'lib/fastly/models/logging_s3.rb', line 17 def name @name end |
#path ⇒ Object
The path to upload logs to.
62 63 64 |
# File 'lib/fastly/models/logging_s3.rb', line 62 def path @path end |
#period ⇒ Object
How frequently log files are finalized so they can be available for reading (in seconds).
38 39 40 |
# File 'lib/fastly/models/logging_s3.rb', line 38 def period @period 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_s3.rb', line 20 def placement @placement end |
#public_key ⇒ Object
A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
65 66 67 |
# File 'lib/fastly/models/logging_s3.rb', line 65 def public_key @public_key end |
#redundancy ⇒ Object
The S3 redundancy level.
68 69 70 |
# File 'lib/fastly/models/logging_s3.rb', line 68 def redundancy @redundancy end |
#response_condition ⇒ Object
The name of an existing condition in the configured endpoint, or leave blank to always execute.
26 27 28 |
# File 'lib/fastly/models/logging_s3.rb', line 26 def response_condition @response_condition end |
#secret_key ⇒ Object
The secret key for your S3 account. Not required if ‘iam_role` is provided.
71 72 73 |
# File 'lib/fastly/models/logging_s3.rb', line 71 def secret_key @secret_key end |
#server_side_encryption ⇒ Object
Set this to ‘AES256` or `aws:kms` to enable S3 Server Side Encryption.
77 78 79 |
# File 'lib/fastly/models/logging_s3.rb', line 77 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`.
74 75 76 |
# File 'lib/fastly/models/logging_s3.rb', line 74 def server_side_encryption_kms_key_id @server_side_encryption_kms_key_id end |
#timestamp_format ⇒ Object
A timestamp format
35 36 37 |
# File 'lib/fastly/models/logging_s3.rb', line 35 def @timestamp_format end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
129 130 131 |
# File 'lib/fastly/models/logging_s3.rb', line 129 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/fastly/models/logging_s3.rb', line 102 def self.attribute_map { :'name' => :'name', :'placement' => :'placement', :'format_version' => :'format_version', :'response_condition' => :'response_condition', :'format' => :'format', :'message_type' => :'message_type', :'timestamp_format' => :'timestamp_format', :'period' => :'period', :'gzip_level' => :'gzip_level', :'compression_codec' => :'compression_codec', :'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' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
410 411 412 |
# File 'lib/fastly/models/logging_s3.rb', line 410 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.fastly_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
178 179 180 181 182 183 184 |
# File 'lib/fastly/models/logging_s3.rb', line 178 def self.fastly_all_of [ :'LoggingCommon', :'LoggingGenericCommon', :'LoggingS3AllOf' ] end |
.fastly_nullable ⇒ Object
List of attributes with nullable: true
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/fastly/models/logging_s3.rb', line 161 def self.fastly_nullable Set.new([ :'placement', :'response_condition', :'timestamp_format', :'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.
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 |
# File 'lib/fastly/models/logging_s3.rb', line 134 def self.fastly_types { :'name' => :'String', :'placement' => :'String', :'format_version' => :'Integer', :'response_condition' => :'String', :'format' => :'String', :'message_type' => :'String', :'timestamp_format' => :'String', :'period' => :'Integer', :'gzip_level' => :'Integer', :'compression_codec' => :'String', :'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' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/fastly/models/logging_s3.rb', line 369 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && placement == o.placement && format_version == o.format_version && response_condition == o.response_condition && format == o.format && == o. && == o. && period == o.period && gzip_level == o.gzip_level && compression_codec == o.compression_codec && 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'lib/fastly/models/logging_s3.rb', line 440 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
511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'lib/fastly/models/logging_s3.rb', line 511 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
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/fastly/models/logging_s3.rb', line 417 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
397 398 399 |
# File 'lib/fastly/models/logging_s3.rb', line 397 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
403 404 405 |
# File 'lib/fastly/models/logging_s3.rb', line 403 def hash [name, placement, format_version, response_condition, format, , , period, gzip_level, compression_codec, access_key, acl, bucket_name, domain, iam_role, path, public_key, redundancy, secret_key, server_side_encryption_kms_key_id, server_side_encryption].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
308 309 310 311 |
# File 'lib/fastly/models/logging_s3.rb', line 308 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
487 488 489 |
# File 'lib/fastly/models/logging_s3.rb', line 487 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
493 494 495 496 497 498 499 500 501 502 503 504 505 |
# File 'lib/fastly/models/logging_s3.rb', line 493 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
481 482 483 |
# File 'lib/fastly/models/logging_s3.rb', line 481 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/fastly/models/logging_s3.rb', line 315 def valid? placement_validator = EnumAttributeValidator.new('String', ["none", "waf_debug", "null"]) return false unless placement_validator.valid?(@placement) format_version_validator = EnumAttributeValidator.new('Integer', [1, 2]) return false unless format_version_validator.valid?(@format_version) = EnumAttributeValidator.new('String', ["classic", "loggly", "logplex", "blank"]) return false unless .valid?(@message_type) compression_codec_validator = EnumAttributeValidator.new('String', ["zstd", "snappy", "gzip"]) return false unless compression_codec_validator.valid?(@compression_codec) true end |