class OCI::Streaming::Models::KafkaSettings

Settings for the Kafka compatibility layer.

Attributes

auto_create_topics_enable[RW]

Enable auto creation of topic on the server. @return [BOOLEAN]

bootstrap_servers[RW]

Bootstrap servers. @return [String]

log_retention_hours[RW]

The number of hours to keep a log file before deleting it (in hours). @return [Integer]

num_partitions[RW]

The default number of log partitions per topic. @return [Integer]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/streaming/models/kafka_settings.rb, line 27
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'bootstrap_servers': :'bootstrapServers',
    'auto_create_topics_enable': :'autoCreateTopicsEnable',
    'log_retention_hours': :'logRetentionHours',
    'num_partitions': :'numPartitions'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :bootstrap_servers The value to assign to the {#bootstrap_servers} property @option attributes [BOOLEAN] :auto_create_topics_enable The value to assign to the {#auto_create_topics_enable} property @option attributes [Integer] :log_retention_hours The value to assign to the {#log_retention_hours} property @option attributes [Integer] :num_partitions The value to assign to the {#num_partitions} property

# File lib/oci/streaming/models/kafka_settings.rb, line 60
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.bootstrap_servers = attributes[:'bootstrapServers'] if attributes[:'bootstrapServers']

  raise 'You cannot provide both :bootstrapServers and :bootstrap_servers' if attributes.key?(:'bootstrapServers') && attributes.key?(:'bootstrap_servers')

  self.bootstrap_servers = attributes[:'bootstrap_servers'] if attributes[:'bootstrap_servers']

  self.auto_create_topics_enable = attributes[:'autoCreateTopicsEnable'] unless attributes[:'autoCreateTopicsEnable'].nil?

  raise 'You cannot provide both :autoCreateTopicsEnable and :auto_create_topics_enable' if attributes.key?(:'autoCreateTopicsEnable') && attributes.key?(:'auto_create_topics_enable')

  self.auto_create_topics_enable = attributes[:'auto_create_topics_enable'] unless attributes[:'auto_create_topics_enable'].nil?

  self.log_retention_hours = attributes[:'logRetentionHours'] if attributes[:'logRetentionHours']

  raise 'You cannot provide both :logRetentionHours and :log_retention_hours' if attributes.key?(:'logRetentionHours') && attributes.key?(:'log_retention_hours')

  self.log_retention_hours = attributes[:'log_retention_hours'] if attributes[:'log_retention_hours']

  self.num_partitions = attributes[:'numPartitions'] if attributes[:'numPartitions']

  raise 'You cannot provide both :numPartitions and :num_partitions' if attributes.key?(:'numPartitions') && attributes.key?(:'num_partitions')

  self.num_partitions = attributes[:'num_partitions'] if attributes[:'num_partitions']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/streaming/models/kafka_settings.rb, line 39
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'bootstrap_servers': :'String',
    'auto_create_topics_enable': :'BOOLEAN',
    'log_retention_hours': :'Integer',
    'num_partitions': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

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

# File lib/oci/streaming/models/kafka_settings.rb, line 98
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    bootstrap_servers == other.bootstrap_servers &&
    auto_create_topics_enable == other.auto_create_topics_enable &&
    log_retention_hours == other.log_retention_hours &&
    num_partitions == other.num_partitions
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/oci/streaming/models/kafka_settings.rb, line 131
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

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

# File lib/oci/streaming/models/kafka_settings.rb, line 111
def eql?(other)
  self == other
end
hash() click to toggle source

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

# File lib/oci/streaming/models/kafka_settings.rb, line 120
def hash
  [bootstrap_servers, auto_create_topics_enable, log_retention_hours, num_partitions].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/oci/streaming/models/kafka_settings.rb, line 164
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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/oci/streaming/models/kafka_settings.rb, line 158
def to_s
  to_hash.to_s
end

Private Instance Methods

_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/oci/streaming/models/kafka_settings.rb, line 181
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