class Fastly::LoggingGenericCommon
Attributes
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.
How the message should be formatted.
A timestamp format
Public Class Methods
Source
# File lib/fastly/models/logging_generic_common.rb, line 57 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/fastly/models/logging_generic_common.rb, line 48 def self.attribute_map { :'message_type' => :'message_type', :'timestamp_format' => :'timestamp_format', :'compression_codec' => :'compression_codec' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/fastly/models/logging_generic_common.rb, line 169 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_generic_common.rb, line 71 def self.fastly_nullable Set.new([ :'timestamp_format', ]) end
List of attributes with nullable: true
Source
# File lib/fastly/models/logging_generic_common.rb, line 62 def self.fastly_types { :'message_type' => :'String', :'timestamp_format' => :'String', :'compression_codec' => :'String' } end
Attribute type mapping.
Source
# File lib/fastly/models/logging_generic_common.rb, line 79 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingGenericCommon` 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::LoggingGenericCommon`. 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?(:'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 end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Public Instance Methods
Source
# File lib/fastly/models/logging_generic_common.rb, line 146 def ==(o) return true if self.equal?(o) self.class == o.class && message_type == o.message_type && timestamp_format == o.timestamp_format && compression_codec == o.compression_codec end
Checks equality by comparing each attribute. @param [Object] Object
to be compared
Source
# File lib/fastly/models/logging_generic_common.rb, line 199 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_generic_common.rb, line 270 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_generic_common.rb, line 176 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_generic_common.rb, line 136 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_generic_common.rb, line 156 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object
to be compared
Source
# File lib/fastly/models/logging_generic_common.rb, line 162 def hash [message_type, timestamp_format, compression_codec].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/fastly/models/logging_generic_common.rb, line 109 def list_invalid_properties invalid_properties = Array.new 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_generic_common.rb, line 126 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
Source
# File lib/fastly/models/logging_generic_common.rb, line 252 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_generic_common.rb, line 240 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_generic_common.rb, line 116 def valid? 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) true end
Check to see if the all the properties in the model are valid @return true if the model is valid