Class: OCI::DatabaseManagement::Models::ExternalClusterInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/external_cluster_instance.rb

Overview

The details of an external cluster instance.

Constant Summary collapse

NODE_ROLE_ENUM = 
[
  NODE_ROLE_HUB = 'HUB'.freeze,
  NODE_ROLE_LEAF = 'LEAF'.freeze,
  NODE_ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_NOT_CONNECTED = 'NOT_CONNECTED'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalClusterInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :component_name (String) —

    The value to assign to the #component_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :external_cluster_id (String) —

    The value to assign to the #external_cluster_id property

  • :external_db_system_id (String) —

    The value to assign to the #external_db_system_id property

  • :external_db_node_id (String) —

    The value to assign to the #external_db_node_id property

  • :external_connector_id (String) —

    The value to assign to the #external_connector_id property

  • :host_name (String) —

    The value to assign to the #host_name property

  • :node_role (String) —

    The value to assign to the #node_role property

  • :crs_base_directory (String) —

    The value to assign to the #crs_base_directory property

  • :adr_home_directory (String) —

    The value to assign to the #adr_home_directory property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 196

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

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

  self.component_name = attributes[:'component_name'] if attributes[:'component_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.external_cluster_id = attributes[:'externalClusterId'] if attributes[:'externalClusterId']

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

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

  self.external_db_system_id = attributes[:'externalDbSystemId'] if attributes[:'externalDbSystemId']

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

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

  self.external_db_node_id = attributes[:'externalDbNodeId'] if attributes[:'externalDbNodeId']

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

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

  self.external_connector_id = attributes[:'externalConnectorId'] if attributes[:'externalConnectorId']

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

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

  self.host_name = attributes[:'hostName'] if attributes[:'hostName']

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

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

  self.node_role = attributes[:'nodeRole'] if attributes[:'nodeRole']

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

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

  self.crs_base_directory = attributes[:'crsBaseDirectory'] if attributes[:'crsBaseDirectory']

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

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

  self.adr_home_directory = attributes[:'adrHomeDirectory'] if attributes[:'adrHomeDirectory']

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

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

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

#adr_home_directory ⇒ String

The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 76

def adr_home_directory
  @adr_home_directory
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 44

def compartment_id
  @compartment_id
end

#component_name ⇒ String

[Required] The name of the external cluster instance.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 40

def component_name
  @component_name
end

#crs_base_directory ⇒ String

The Oracle base location of Cluster Ready Services (CRS).

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 72

def crs_base_directory
  @crs_base_directory
end

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

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>>) 


106
107
108
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 106

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the cluster instance. The name does not have to be unique.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 36

def display_name
  @display_name
end

#external_cluster_id ⇒ String

[Required] The OCID of the external cluster that the cluster instance belongs to.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 48

def external_cluster_id
  @external_cluster_id
end

#external_connector_id ⇒ String

The OCID of the external connector.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 60

def external_connector_id
  @external_connector_id
end

#external_db_node_id ⇒ String

The OCID of the external DB node.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 56

def external_db_node_id
  @external_db_node_id
end

#external_db_system_id ⇒ String

[Required] The OCID of the external DB system that the cluster instance is a part of.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 52

def external_db_system_id
  @external_db_system_id
end

#freeform_tags ⇒ Hash<String, String>

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>) 


99
100
101
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 99

def freeform_tags
  @freeform_tags
end

#host_name ⇒ String

The name of the host on which the cluster instance is running.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 64

def host_name
  @host_name
end

#id ⇒ String

[Required] The OCID of the external cluster instance.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 32

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 84

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the external cluster instance.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 80

def lifecycle_state
  @lifecycle_state
end

#node_role ⇒ String

The role of the cluster node.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 68

def node_role
  @node_role
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

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

Returns:

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


115
116
117
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 115

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the external cluster instance was created.

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 88

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the external cluster instance was last updated.

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 92

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 118

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'component_name': :'componentName',
    'compartment_id': :'compartmentId',
    'external_cluster_id': :'externalClusterId',
    'external_db_system_id': :'externalDbSystemId',
    'external_db_node_id': :'externalDbNodeId',
    'external_connector_id': :'externalConnectorId',
    'host_name': :'hostName',
    'node_role': :'nodeRole',
    'crs_base_directory': :'crsBaseDirectory',
    'adr_home_directory': :'adrHomeDirectory',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 145

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'component_name': :'String',
    'compartment_id': :'String',
    'external_cluster_id': :'String',
    'external_db_system_id': :'String',
    'external_db_node_id': :'String',
    'external_connector_id': :'String',
    'host_name': :'String',
    'node_role': :'String',
    'crs_base_directory': :'String',
    'adr_home_directory': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 346

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    component_name == other.component_name &&
    compartment_id == other.compartment_id &&
    external_cluster_id == other.external_cluster_id &&
    external_db_system_id == other.external_db_system_id &&
    external_db_node_id == other.external_db_node_id &&
    external_connector_id == other.external_connector_id &&
    host_name == other.host_name &&
    node_role == other.node_role &&
    crs_base_directory == other.crs_base_directory &&
    adr_home_directory == other.adr_home_directory &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 394

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


374
375
376
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 374

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



383
384
385
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 383

def hash
  [id, display_name, component_name, compartment_id, external_cluster_id, external_db_system_id, external_db_node_id, external_connector_id, host_name, node_role, crs_base_directory, adr_home_directory, lifecycle_state, lifecycle_details, time_created, time_updated, 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



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 427

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



421
422
423
 
# File 'lib/oci/database_management/models/external_cluster_instance.rb', line 421

def to_s
  to_hash.to_s
end