class Fastly::LoggingKafkaResponsePost

Attributes

auth_method[RW]

SASL authentication method.

brokers[RW]

A comma-separated list of IP addresses or hostnames of Kafka brokers. Required.

compression_codec[RW]

The codec used for compression of your logs.

created_at[RW]

Date and time in ISO 8601 format.

deleted_at[RW]

Date and time in ISO 8601 format.

format[RW]
format_version[RW]

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`.

name[RW]

The name for the real-time logging configuration.

parse_log_keyvals[RW]

Enables parsing of key=value tuples from the beginning of a logline, turning them into [record headers](cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers).

password[RW]

SASL password.

placement[RW]

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`.

request_max_bytes[RW]

The maximum number of bytes sent in one request. Defaults ‘0` (no limit).

required_acks[RW]

The number of acknowledgements a leader must receive before a write is considered successful.

response_condition[RW]

The name of an existing condition in the configured endpoint, or leave blank to always execute.

service_id[RW]
tls_ca_cert[RW]

A secure certificate to authenticate a server with. Must be in PEM format.

tls_client_cert[RW]

The client certificate used to make authenticated requests. Must be in PEM format.

tls_client_key[RW]

The client private key used to make authenticated requests. Must be in PEM format.

tls_hostname[RW]

The hostname to verify the server’s certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported.

topic[RW]

The Kafka topic to send logs to. Required.

updated_at[RW]

Date and time in ISO 8601 format.

use_tls[RW]
user[RW]

SASL user.

version[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/logging_kafka_response_post.rb, line 138
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/fastly/models/logging_kafka_response_post.rb, line 108
def self.attribute_map
  {
    :'name' => :'name',
    :'placement' => :'placement',
    :'response_condition' => :'response_condition',
    :'format' => :'format',
    :'format_version' => :'format_version',
    :'tls_ca_cert' => :'tls_ca_cert',
    :'tls_client_cert' => :'tls_client_cert',
    :'tls_client_key' => :'tls_client_key',
    :'tls_hostname' => :'tls_hostname',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'service_id' => :'service_id',
    :'version' => :'version',
    :'topic' => :'topic',
    :'brokers' => :'brokers',
    :'compression_codec' => :'compression_codec',
    :'required_acks' => :'required_acks',
    :'request_max_bytes' => :'request_max_bytes',
    :'parse_log_keyvals' => :'parse_log_keyvals',
    :'auth_method' => :'auth_method',
    :'user' => :'user',
    :'password' => :'password',
    :'use_tls' => :'use_tls'
  }
end
build_from_hash(attributes) click to toggle source

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_kafka_response_post.rb, line 449
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
fastly_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/fastly/models/logging_kafka_response_post.rb, line 189
def self.fastly_all_of
  [
  :'LoggingCommon',
  :'LoggingFormatVersionInteger',
  :'LoggingKafkaAdditional',
  :'LoggingTlsCommon',
  :'ServiceIdAndVersionString',
  :'Timestamps'
  ]
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/logging_kafka_response_post.rb, line 173
def self.fastly_nullable
  Set.new([
    :'placement',
    :'response_condition',
    :'tls_ca_cert',
    :'tls_client_cert',
    :'tls_client_key',
    :'tls_hostname',
    :'created_at',
    :'deleted_at',
    :'updated_at',
    :'compression_codec',
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/logging_kafka_response_post.rb, line 143
def self.fastly_types
  {
    :'name' => :'String',
    :'placement' => :'String',
    :'response_condition' => :'String',
    :'format' => :'String',
    :'format_version' => :'Integer',
    :'tls_ca_cert' => :'String',
    :'tls_client_cert' => :'String',
    :'tls_client_key' => :'String',
    :'tls_hostname' => :'String',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'service_id' => :'String',
    :'version' => :'String',
    :'topic' => :'String',
    :'brokers' => :'String',
    :'compression_codec' => :'String',
    :'required_acks' => :'Integer',
    :'request_max_bytes' => :'Integer',
    :'parse_log_keyvals' => :'Boolean',
    :'auth_method' => :'String',
    :'user' => :'String',
    :'password' => :'String',
    :'use_tls' => :'LoggingUseTlsString'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/fastly/models/logging_kafka_response_post.rb, line 202
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingKafkaResponsePost` 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::LoggingKafkaResponsePost`. 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?(:'format_version')
    self.format_version = attributes[:'format_version']
  else
    self.format_version = FORMAT_VERSION::v2
  end

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

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

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

  if attributes.key?(:'tls_hostname')
    self.tls_hostname = attributes[:'tls_hostname']
  else
    self.tls_hostname = 'null'
  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?(:'topic')
    self.topic = attributes[:'topic']
  end

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

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

  if attributes.key?(:'required_acks')
    self.required_acks = attributes[:'required_acks']
  else
    self.required_acks = REQUIRED_ACKS::one
  end

  if attributes.key?(:'request_max_bytes')
    self.request_max_bytes = attributes[:'request_max_bytes']
  else
    self.request_max_bytes = 0
  end

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

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

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

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

  if attributes.key?(:'use_tls')
    self.use_tls = attributes[:'use_tls']
  else
    self.use_tls = '0'
  end
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/fastly/models/logging_kafka_response_post.rb, line 405
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 &&
      format_version == o.format_version &&
      tls_ca_cert == o.tls_ca_cert &&
      tls_client_cert == o.tls_client_cert &&
      tls_client_key == o.tls_client_key &&
      tls_hostname == o.tls_hostname &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      service_id == o.service_id &&
      version == o.version &&
      topic == o.topic &&
      brokers == o.brokers &&
      compression_codec == o.compression_codec &&
      required_acks == o.required_acks &&
      request_max_bytes == o.request_max_bytes &&
      parse_log_keyvals == o.parse_log_keyvals &&
      auth_method == o.auth_method &&
      user == o.user &&
      password == o.password &&
      use_tls == o.use_tls
end
_deserialize(type, value) click to toggle source

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_kafka_response_post.rb, line 479
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) click to toggle source

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_kafka_response_post.rb, line 550
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
auth_method=(auth_method) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] auth_method Object to be assigned

# File lib/fastly/models/logging_kafka_response_post.rb, line 395
def auth_method=(auth_method)
  validator = EnumAttributeValidator.new('String', ["plain", "scram-sha-256", "scram-sha-512"])
  unless validator.valid?(auth_method)
    fail ArgumentError, "invalid value for \"auth_method\", must be one of #{validator.allowable_values}."
  end
  @auth_method = auth_method
end
build_from_hash(attributes) click to toggle source

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_kafka_response_post.rb, line 456
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
compression_codec=(compression_codec) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] compression_codec Object to be assigned

# File lib/fastly/models/logging_kafka_response_post.rb, line 375
def compression_codec=(compression_codec)
  validator = EnumAttributeValidator.new('String', ["gzip", "snappy", "lz4", "null"])
  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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/fastly/models/logging_kafka_response_post.rb, line 436
def eql?(o)
  self == o
end
format_version=(format_version) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] format_version Object to be assigned

# File lib/fastly/models/logging_kafka_response_post.rb, line 365
def format_version=(format_version)
  validator = EnumAttributeValidator.new('Integer', [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
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/fastly/models/logging_kafka_response_post.rb, line 442
def hash
  [name, placement, response_condition, format, format_version, tls_ca_cert, tls_client_cert, tls_client_key, tls_hostname, created_at, deleted_at, updated_at, service_id, version, topic, brokers, compression_codec, required_acks, request_max_bytes, parse_log_keyvals, auth_method, user, password, use_tls].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/fastly/models/logging_kafka_response_post.rb, line 332
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
placement=(placement) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] placement Object to be assigned

# File lib/fastly/models/logging_kafka_response_post.rb, line 355
def placement=(placement)
  validator = EnumAttributeValidator.new('String', ["none", "waf_debug", "null"])
  unless validator.valid?(placement)
    fail ArgumentError, "invalid value for \"placement\", must be one of #{validator.allowable_values}."
  end
  @placement = placement
end
required_acks=(required_acks) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] required_acks Object to be assigned

# File lib/fastly/models/logging_kafka_response_post.rb, line 385
def required_acks=(required_acks)
  validator = EnumAttributeValidator.new('Integer', [1, 0, -1])
  unless validator.valid?(required_acks)
    fail ArgumentError, "invalid value for \"required_acks\", must be one of #{validator.allowable_values}."
  end
  @required_acks = required_acks
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/logging_kafka_response_post.rb, line 526
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/logging_kafka_response_post.rb, line 532
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/fastly/models/logging_kafka_response_post.rb, line 520
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_kafka_response_post.rb, line 339
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)
  compression_codec_validator = EnumAttributeValidator.new('String', ["gzip", "snappy", "lz4", "null"])
  return false unless compression_codec_validator.valid?(@compression_codec)
  required_acks_validator = EnumAttributeValidator.new('Integer', [1, 0, -1])
  return false unless required_acks_validator.valid?(@required_acks)
  auth_method_validator = EnumAttributeValidator.new('String', ["plain", "scram-sha-256", "scram-sha-512"])
  return false unless auth_method_validator.valid?(@auth_method)
  true
end