Class: OCI::Bds::Models::BdsInstanceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/bds_instance_summary.rb

Overview

Summary details of the Big Data Service cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BdsInstanceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 149

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

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

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

  self.number_of_nodes_requiring_maintenance_reboot = attributes[:'numberOfNodesRequiringMaintenanceReboot'] if attributes[:'numberOfNodesRequiringMaintenanceReboot']

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

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

  self.cluster_version = attributes[:'clusterVersion'] if attributes[:'clusterVersion']

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

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

  self.is_high_availability = attributes[:'isHighAvailability'] unless attributes[:'isHighAvailability'].nil?

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

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

  self.is_secure = attributes[:'isSecure'] unless attributes[:'isSecure'].nil?

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

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

  self.is_cloud_sql_configured = attributes[:'isCloudSqlConfigured'] unless attributes[:'isCloudSqlConfigured'].nil?
  self.is_cloud_sql_configured = false if is_cloud_sql_configured.nil? && !attributes.key?(:'isCloudSqlConfigured') # rubocop:disable Style/StringLiterals

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

  self.is_cloud_sql_configured = attributes[:'is_cloud_sql_configured'] unless attributes[:'is_cloud_sql_configured'].nil?
  self.is_cloud_sql_configured = false if is_cloud_sql_configured.nil? && !attributes.key?(:'isCloudSqlConfigured') && !attributes.key?(:'is_cloud_sql_configured') # rubocop:disable Style/StringLiterals

  self.is_kafka_configured = attributes[:'isKafkaConfigured'] unless attributes[:'isKafkaConfigured'].nil?
  self.is_kafka_configured = false if is_kafka_configured.nil? && !attributes.key?(:'isKafkaConfigured') # rubocop:disable Style/StringLiterals

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

  self.is_kafka_configured = attributes[:'is_kafka_configured'] unless attributes[:'is_kafka_configured'].nil?
  self.is_kafka_configured = false if is_kafka_configured.nil? && !attributes.key?(:'isKafkaConfigured') && !attributes.key?(:'is_kafka_configured') # rubocop:disable Style/StringLiterals

  self.cluster_profile = attributes[:'clusterProfile'] if attributes[:'clusterProfile']

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

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

  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_earliest_certificate_expiration = attributes[:'timeEarliestCertificateExpiration'] if attributes[:'timeEarliestCertificateExpiration']

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

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

  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']
end

Instance Attribute Details

#cluster_profile ⇒ String

Profile of the Big Data Service cluster.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 57

def cluster_profile
  @cluster_profile
end

#cluster_version ⇒ String

Version of the Hadoop distribution.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 37

def cluster_version
  @cluster_version
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 17

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


77
78
79
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 77

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name of the cluster.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 21

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


71
72
73
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 71

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Big Data Service resource.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 13

def id
  @id
end

#is_cloud_sql_configured ⇒ BOOLEAN

[Required] Boolean flag specifying whether Cloud SQL is configured or not.

Returns:

  • (BOOLEAN) 


49
50
51
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 49

def is_cloud_sql_configured
  @is_cloud_sql_configured
end

#is_high_availability ⇒ BOOLEAN

[Required] Boolean flag specifying whether or not the cluster is highly available(HA).

Returns:

  • (BOOLEAN) 


41
42
43
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 41

def is_high_availability
  @is_high_availability
end

#is_kafka_configured ⇒ BOOLEAN

[Required] Boolean flag specifying whether Kafka is configured or not.

Returns:

  • (BOOLEAN) 


53
54
55
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 53

def is_kafka_configured
  @is_kafka_configured
end

#is_secure ⇒ BOOLEAN

[Required] Boolean flag specifying whether or not the cluster should be set up as secure.

Returns:

  • (BOOLEAN) 


45
46
47
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 45

def is_secure
  @is_secure
end

#lifecycle_state ⇒ String

[Required] The state of the cluster.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 25

def lifecycle_state
  @lifecycle_state
end

#number_of_nodes ⇒ Integer

[Required] The number of nodes that form the cluster.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 29

def number_of_nodes
  @number_of_nodes
end

#number_of_nodes_requiring_maintenance_reboot ⇒ Integer

Number of nodes that require a maintenance reboot

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 33

def number_of_nodes_requiring_maintenance_reboot
  @number_of_nodes_requiring_maintenance_reboot
end

#time_created ⇒ DateTime

[Required] The time the cluster was created, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 61

def time_created
  @time_created
end

#time_earliest_certificate_expiration ⇒ DateTime

The earliest time of certificate expiration date across the certificates of all current nodes under this cluster.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 65

def time_earliest_certificate_expiration
  @time_earliest_certificate_expiration
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'number_of_nodes': :'numberOfNodes',
    'number_of_nodes_requiring_maintenance_reboot': :'numberOfNodesRequiringMaintenanceReboot',
    'cluster_version': :'clusterVersion',
    'is_high_availability': :'isHighAvailability',
    'is_secure': :'isSecure',
    'is_cloud_sql_configured': :'isCloudSqlConfigured',
    'is_kafka_configured': :'isKafkaConfigured',
    'cluster_profile': :'clusterProfile',
    'time_created': :'timeCreated',
    'time_earliest_certificate_expiration': :'timeEarliestCertificateExpiration',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'number_of_nodes': :'Integer',
    'number_of_nodes_requiring_maintenance_reboot': :'Integer',
    'cluster_version': :'String',
    'is_high_availability': :'BOOLEAN',
    'is_secure': :'BOOLEAN',
    'is_cloud_sql_configured': :'BOOLEAN',
    'is_kafka_configured': :'BOOLEAN',
    'cluster_profile': :'String',
    'time_created': :'DateTime',
    'time_earliest_certificate_expiration': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 259

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    number_of_nodes == other.number_of_nodes &&
    number_of_nodes_requiring_maintenance_reboot == other.number_of_nodes_requiring_maintenance_reboot &&
    cluster_version == other.cluster_version &&
    is_high_availability == other.is_high_availability &&
    is_secure == other.is_secure &&
    is_cloud_sql_configured == other.is_cloud_sql_configured &&
    is_kafka_configured == other.is_kafka_configured &&
    cluster_profile == other.cluster_profile &&
    time_created == other.time_created &&
    time_earliest_certificate_expiration == other.time_earliest_certificate_expiration &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 304

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


284
285
286
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 284

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



293
294
295
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 293

def hash
  [id, compartment_id, display_name, lifecycle_state, number_of_nodes, number_of_nodes_requiring_maintenance_reboot, cluster_version, is_high_availability, is_secure, is_cloud_sql_configured, is_kafka_configured, cluster_profile, time_created, time_earliest_certificate_expiration, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 337

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



331
332
333
 
# File 'lib/oci/bds/models/bds_instance_summary.rb', line 331

def to_s
  to_hash.to_s
end