class Fastly::LoggingKinesisAdditional
Attributes
The access key associated with the target Amazon Kinesis stream. Not required if ‘iam_role` is specified.
A Fastly
[log format string](docs.fastly.com/en/guides/custom-log-formats).
The ARN for an IAM role granting Fastly
access to the target Amazon Kinesis stream. Not required if ‘access_key` and `secret_key` are provided.
The name for the real-time logging configuration.
The secret key associated with the target Amazon Kinesis stream. Not required if ‘iam_role` is specified.
The Amazon Kinesis stream to send logs to. Required.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/fastly/models/logging_kinesis_additional.rb, line 53 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/fastly/models/logging_kinesis_additional.rb, line 39 def self.attribute_map { :'name' => :'name', :'placement' => :'placement', :'format' => :'format', :'topic' => :'topic', :'region' => :'region', :'secret_key' => :'secret_key', :'access_key' => :'access_key', :'iam_role' => :'iam_role' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/fastly/models/logging_kinesis_additional.rb, line 174 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
List of attributes with nullable: true
# File lib/fastly/models/logging_kinesis_additional.rb, line 72 def self.fastly_nullable Set.new([ :'placement', :'secret_key', :'access_key', :'iam_role' ]) end
Attribute type mapping.
# File lib/fastly/models/logging_kinesis_additional.rb, line 58 def self.fastly_types { :'name' => :'String', :'placement' => :'LoggingPlacement', :'format' => :'String', :'topic' => :'String', :'region' => :'AwsRegion', :'secret_key' => :'String', :'access_key' => :'String', :'iam_role' => :'String' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/fastly/models/logging_kinesis_additional.rb, line 83 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingKinesisAdditional` 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::LoggingKinesisAdditional`. 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') self.format = attributes[:'format'] else self.format = '{\"timestamp\":\"%{begin:%Y-%m-%dT%H:%M:%S}t\",\"time_elapsed\":\"%{time.elapsed.usec}V\",\"is_tls\":\"%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V\",\"client_ip\":\"%{req.http.Fastly-Client-IP}V\",\"geo_city\":\"%{client.geo.city}V\",\"geo_country_code\":\"%{client.geo.country_code}V\",\"request\":\"%{req.request}V\",\"host\":\"%{req.http.Fastly-Orig-Host}V\",\"url\":\"%{json.escape(req.url)}V\",\"request_referer\":\"%{json.escape(req.http.Referer)}V\",\"request_user_agent\":\"%{json.escape(req.http.User-Agent)}V\",\"request_accept_language\":\"%{json.escape(req.http.Accept-Language)}V\",\"request_accept_charset\":\"%{json.escape(req.http.Accept-Charset)}V\",\"cache_status\":\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\"}' end if attributes.key?(:'topic') self.topic = attributes[:'topic'] end if attributes.key?(:'region') self.region = attributes[:'region'] end if attributes.key?(:'secret_key') self.secret_key = attributes[:'secret_key'] end if attributes.key?(:'access_key') self.access_key = attributes[:'access_key'] end if attributes.key?(:'iam_role') self.iam_role = attributes[:'iam_role'] end end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/fastly/models/logging_kinesis_additional.rb, line 146 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && placement == o.placement && format == o.format && topic == o.topic && region == o.region && secret_key == o.secret_key && access_key == o.access_key && iam_role == o.iam_role end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/fastly/models/logging_kinesis_additional.rb, line 204 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
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
# File lib/fastly/models/logging_kinesis_additional.rb, line 275 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/fastly/models/logging_kinesis_additional.rb, line 181 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
@see the ‘==` method @param [Object] Object
to be compared
# File lib/fastly/models/logging_kinesis_additional.rb, line 161 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/fastly/models/logging_kinesis_additional.rb, line 167 def hash [name, placement, format, topic, region, secret_key, access_key, iam_role].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/fastly/models/logging_kinesis_additional.rb, line 133 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/fastly/models/logging_kinesis_additional.rb, line 257 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 string representation of the object @return [String] String presentation of the object
# File lib/fastly/models/logging_kinesis_additional.rb, line 245 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/fastly/models/logging_kinesis_additional.rb, line 140 def valid? true end