Class: OCI::Streaming::Models::KafkaSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/streaming/models/kafka_settings.rb

Overview

Settings for the Kafka compatibility layer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KafkaSettings

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# 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

Instance Attribute Details

#auto_create_topics_enableBOOLEAN

Enable auto creation of topic on the server.

Returns:

  • (BOOLEAN)


16
17
18
# File 'lib/oci/streaming/models/kafka_settings.rb', line 16

def auto_create_topics_enable
  @auto_create_topics_enable
end

#bootstrap_serversString

Bootstrap servers.

Returns:

  • (String)


12
13
14
# File 'lib/oci/streaming/models/kafka_settings.rb', line 12

def bootstrap_servers
  @bootstrap_servers
end

#log_retention_hoursInteger

The number of hours to keep a log file before deleting it (in hours).

Returns:

  • (Integer)


20
21
22
# File 'lib/oci/streaming/models/kafka_settings.rb', line 20

def log_retention_hours
  @log_retention_hours
end

#num_partitionsInteger

The default number of log partitions per topic.

Returns:

  • (Integer)


24
25
26
# File 'lib/oci/streaming/models/kafka_settings.rb', line 24

def num_partitions
  @num_partitions
end

Class Method Details

.attribute_mapObject

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



27
28
29
30
31
32
33
34
35
36
# 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

.swagger_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



98
99
100
101
102
103
104
105
106
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# 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) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


111
112
113
# File 'lib/oci/streaming/models/kafka_settings.rb', line 111

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



120
121
122
# 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_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



158
159
160
# File 'lib/oci/streaming/models/kafka_settings.rb', line 158

def to_s
  to_hash.to_s
end