class Fastly::LoggingS3Response
Attributes
The access key for your S3 account. Not required if ‘iam_role` is provided.
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.
The bucket name for S3 account.
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.
Date and time in ISO 8601 format.
Date and time in ISO 8601 format.
The domain of the Amazon S3 endpoint.
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.)
A Fastly
[log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
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`.
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.
The geographic region where the logs will be processed before streaming. Valid values are ‘us`, `eu`, and `none` for global.
How the message should be formatted.
The name for the real-time logging configuration.
The path to upload logs to.
How frequently log files are finalized so they can be available for reading (in seconds).
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`.
A PGP public key that Fastly
will use to encrypt your log files before writing them to disk.
The S3 redundancy level.
The name of an existing condition in the configured endpoint, or leave blank to always execute.
The secret key for your S3 account. Not required if ‘iam_role` is provided.
Set this to ‘AES256` or `aws:kms` to enable S3 Server
Side Encryption.
Optional server-side KMS Key Id. Must be set if ‘server_side_encryption` is set to `aws:kms` or `AES256`.
A timestamp format
Date and time in ISO 8601 format.
Public Class Methods
Source
# File lib/fastly/models/logging_s3_response.rb, line 155 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/fastly/models/logging_s3_response.rb, line 121 def self.attribute_map { :'name' => :'name', :'placement' => :'placement', :'response_condition' => :'response_condition', :'format' => :'format', :'log_processing_region' => :'log_processing_region', :'format_version' => :'format_version', :'message_type' => :'message_type', :'timestamp_format' => :'timestamp_format', :'compression_codec' => :'compression_codec', :'period' => :'period', :'gzip_level' => :'gzip_level', :'created_at' => :'created_at', :'deleted_at' => :'deleted_at', :'updated_at' => :'updated_at', :'service_id' => :'service_id', :'version' => :'version', :'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
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/fastly/models/logging_s3_response.rb, line 512 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/fastly/models/logging_s3_response.rb, line 214 def self.fastly_all_of [ :'LoggingCommonResponse', :'LoggingGenericCommonResponse', :'LoggingS3Additional', :'ServiceIdAndVersionString', :'Timestamps' ] end
List of class defined in allOf (OpenAPI v3)
Source
# File lib/fastly/models/logging_s3_response.rb, line 194 def self.fastly_nullable Set.new([ :'placement', :'response_condition', :'timestamp_format', :'created_at', :'deleted_at', :'updated_at', :'access_key', :'iam_role', :'path', :'public_key', :'redundancy', :'secret_key', :'server_side_encryption_kms_key_id', :'server_side_encryption', ]) end
List of attributes with nullable: true
Source
# File lib/fastly/models/logging_s3_response.rb, line 160 def self.fastly_types { :'name' => :'String', :'placement' => :'String', :'response_condition' => :'String', :'format' => :'String', :'log_processing_region' => :'String', :'format_version' => :'String', :'message_type' => :'String', :'timestamp_format' => :'String', :'compression_codec' => :'String', :'period' => :'String', :'gzip_level' => :'String', :'created_at' => :'Time', :'deleted_at' => :'Time', :'updated_at' => :'Time', :'service_id' => :'String', :'version' => :'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', :'file_max_bytes' => :'Integer' } end
Attribute type mapping.
Source
# File lib/fastly/models/logging_s3_response.rb, line 226 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingS3Response` 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::LoggingS3Response`. 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'] else self.format = '%h %l %u %t \"%r\" %>s %b' end if attributes.key?(:'log_processing_region') self.log_processing_region = attributes[:'log_processing_region'] else self.log_processing_region = 'none' end if attributes.key?(:'format_version') self.format_version = attributes[:'format_version'] else self.format_version = '2' end if attributes.key?(:'message_type') self.message_type = attributes[:'message_type'] else self.message_type = 'classic' end if attributes.key?(:'timestamp_format') self.timestamp_format = attributes[:'timestamp_format'] end if attributes.key?(:'compression_codec') self.compression_codec = attributes[:'compression_codec'] 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?(:'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 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Public Instance Methods
Source
# File lib/fastly/models/logging_s3_response.rb, line 464 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 && log_processing_region == o.log_processing_region && format_version == o.format_version && message_type == o.message_type && timestamp_format == o.timestamp_format && compression_codec == o.compression_codec && period == o.period && gzip_level == o.gzip_level && created_at == o.created_at && deleted_at == o.deleted_at && updated_at == o.updated_at && service_id == o.service_id && version == o.version && 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
Checks equality by comparing each attribute. @param [Object] Object
to be compared
Source
# File lib/fastly/models/logging_s3_response.rb, line 542 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/fastly/models/logging_s3_response.rb, line 613 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/fastly/models/logging_s3_response.rb, line 519 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/fastly/models/logging_s3_response.rb, line 444 def compression_codec=(compression_codec) validator = EnumAttributeValidator.new('String', ["zstd", "snappy", "gzip"]) unless validator.valid?(compression_codec) fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{validator.allowable_values}." end @compression_codec = compression_codec end
Custom attribute writer method checking allowed values (enum). @param [Object] compression_codec
Object
to be assigned
Source
# File lib/fastly/models/logging_s3_response.rb, line 499 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object
to be compared
Source
# File lib/fastly/models/logging_s3_response.rb, line 454 def file_max_bytes=(file_max_bytes) if !file_max_bytes.nil? && file_max_bytes < 1048576 fail ArgumentError, 'invalid value for "file_max_bytes", must be greater than or equal to 1048576.' end @file_max_bytes = file_max_bytes end
Custom attribute writer method with validation @param [Object] file_max_bytes
Value to be assigned
Source
# File lib/fastly/models/logging_s3_response.rb, line 424 def format_version=(format_version) validator = EnumAttributeValidator.new('String', ["1", "2"]) unless validator.valid?(format_version) fail ArgumentError, "invalid value for \"format_version\", must be one of #{validator.allowable_values}." end @format_version = format_version end
Custom attribute writer method checking allowed values (enum). @param [Object] format_version
Object
to be assigned
Source
# File lib/fastly/models/logging_s3_response.rb, line 505 def hash [name, placement, response_condition, format, log_processing_region, format_version, message_type, timestamp_format, compression_codec, period, gzip_level, created_at, deleted_at, updated_at, service_id, version, 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
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/fastly/models/logging_s3_response.rb, line 376 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/fastly/models/logging_s3_response.rb, line 414 def log_processing_region=(log_processing_region) validator = EnumAttributeValidator.new('String', ["none", "eu", "us"]) unless validator.valid?(log_processing_region) fail ArgumentError, "invalid value for \"log_processing_region\", must be one of #{validator.allowable_values}." end @log_processing_region = log_processing_region end
Custom attribute writer method checking allowed values (enum). @param [Object] log_processing_region
Object
to be assigned
Source
# File lib/fastly/models/logging_s3_response.rb, line 434 def message_type=(message_type) validator = EnumAttributeValidator.new('String', ["classic", "loggly", "logplex", "blank"]) unless validator.valid?(message_type) fail ArgumentError, "invalid value for \"message_type\", must be one of #{validator.allowable_values}." end @message_type = message_type end
Custom attribute writer method checking allowed values (enum). @param [Object] message_type
Object
to be assigned
Source
# File lib/fastly/models/logging_s3_response.rb, line 404 def placement=(placement) validator = EnumAttributeValidator.new('String', ["none", "null"]) unless validator.valid?(placement) fail ArgumentError, "invalid value for \"placement\", must be one of #{validator.allowable_values}." end @placement = placement end
Custom attribute writer method checking allowed values (enum). @param [Object] placement Object
to be assigned
Source
Source
# File lib/fastly/models/logging_s3_response.rb, line 595 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/fastly/models/logging_s3_response.rb, line 583 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/fastly/models/logging_s3_response.rb, line 387 def valid? placement_validator = EnumAttributeValidator.new('String', ["none", "null"]) return false unless placement_validator.valid?(@placement) log_processing_region_validator = EnumAttributeValidator.new('String', ["none", "eu", "us"]) return false unless log_processing_region_validator.valid?(@log_processing_region) format_version_validator = EnumAttributeValidator.new('String', ["1", "2"]) return false unless format_version_validator.valid?(@format_version) message_type_validator = EnumAttributeValidator.new('String', ["classic", "loggly", "logplex", "blank"]) return false unless message_type_validator.valid?(@message_type) compression_codec_validator = EnumAttributeValidator.new('String', ["zstd", "snappy", "gzip"]) return false unless compression_codec_validator.valid?(@compression_codec) return false if !@file_max_bytes.nil? && @file_max_bytes < 1048576 true end
Check to see if the all the properties in the model are valid @return true if the model is valid