Class: OCI::ManagedKafka::Models::KafkaClusterSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/managed_kafka/models/kafka_cluster_summary.rb

Overview

Summary information about a KafkaCluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KafkaClusterSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 174

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.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.access_subnets = attributes[:'accessSubnets'] if attributes[:'accessSubnets']

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

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

  self.kafka_version = attributes[:'kafkaVersion'] if attributes[:'kafkaVersion']

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

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

  self.cluster_type = attributes[:'clusterType'] if attributes[:'clusterType']

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

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

  self.broker_shape = attributes[:'brokerShape'] if attributes[:'brokerShape']

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

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

  self.cluster_config_id = attributes[:'clusterConfigId'] if attributes[:'clusterConfigId']

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

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

  self.cluster_config_version = attributes[:'clusterConfigVersion'] if attributes[:'clusterConfigVersion']

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

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

  self.coordination_type = attributes[:'coordinationType'] if attributes[:'coordinationType']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#access_subnets ⇒ Array<OCI::ManagedKafka::Models::SubnetSet>

[Required] Subnets where broker/coordinator VNICs will be created.

Returns:



49
50
51
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 49

def access_subnets
  @access_subnets
end

#broker_shape ⇒ OCI::ManagedKafka::Models::BrokerShape

This attribute is required.

Returns:



64
65
66
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 64

def broker_shape
  @broker_shape
end

#cluster_config_id ⇒ String

[Required] The OCID of Kafka Cluster configuration object

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 68

def cluster_config_id
  @cluster_config_id
end

#cluster_config_version ⇒ Integer

[Required] The version of configuration object

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 72

def cluster_config_version
  @cluster_config_version
end

#cluster_type ⇒ String

[Required] Type of the cluster to spin up. DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node PRODUCTION - Minimum allowed broker count is 3

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 60

def cluster_type
  @cluster_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 21

def compartment_id
  @compartment_id
end

#coordination_type ⇒ String

Kafka coordination type. Set of available types depends on Kafka version

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 76

def coordination_type
  @coordination_type
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


92
93
94
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 92

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 17

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


84
85
86
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 84

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the KafkaCluster.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 13

def id
  @id
end

#kafka_version ⇒ String

[Required] Version of Kafka to use to spin up the cluster

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 53

def kafka_version
  @kafka_version
end

#lifecycle_details ⇒ String

A message that describes the current state of the KafkaCluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 45

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the KafkaCluster.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 39

def lifecycle_state
  @lifecycle_state
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


99
100
101
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 99

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the KafkaCluster was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


28
29
30
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 28

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the KafkaCluster was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 35

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 102

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'access_subnets': :'accessSubnets',
    'kafka_version': :'kafkaVersion',
    'cluster_type': :'clusterType',
    'broker_shape': :'brokerShape',
    'cluster_config_id': :'clusterConfigId',
    'cluster_config_version': :'clusterConfigVersion',
    'coordination_type': :'coordinationType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 127

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'access_subnets': :'Array<OCI::ManagedKafka::Models::SubnetSet>',
    'kafka_version': :'String',
    'cluster_type': :'String',
    'broker_shape': :'OCI::ManagedKafka::Models::BrokerShape',
    'cluster_config_id': :'String',
    'cluster_config_version': :'Integer',
    'coordination_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 286

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    access_subnets == other.access_subnets &&
    kafka_version == other.kafka_version &&
    cluster_type == other.cluster_type &&
    broker_shape == other.broker_shape &&
    cluster_config_id == other.cluster_config_id &&
    cluster_config_version == other.cluster_config_version &&
    coordination_type == other.coordination_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 332

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


312
313
314
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 312

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



321
322
323
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 321

def hash
  [id, display_name, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, access_subnets, kafka_version, cluster_type, broker_shape, cluster_config_id, cluster_config_version, coordination_type, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 365

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



359
360
361
 
# File 'lib/oci/managed_kafka/models/kafka_cluster_summary.rb', line 359

def to_s
  to_hash.to_s
end