Class: OCI::DatabaseManagement::Models::ExternalCluster

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

Overview

The details of an external cluster.

Constant Summary collapse

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 = {}) ⇒ ExternalCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 206

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

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

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

  self.is_flex_cluster = attributes[:'isFlexCluster'] unless attributes[:'isFlexCluster'].nil?

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

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

  self.additional_details = attributes[:'additionalDetails'] if attributes[:'additionalDetails']

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

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

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

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

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

  self.vip_configurations = attributes[:'vipConfigurations'] if attributes[:'vipConfigurations']

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

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

  self.scan_configurations = attributes[:'scanConfigurations'] if attributes[:'scanConfigurations']

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

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

  self.ocr_file_location = attributes[:'ocrFileLocation'] if attributes[:'ocrFileLocation']

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

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

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

  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

#additional_details ⇒ Hash<String, String>

The additional details of the external cluster defined in {\"key\": \"value\"} format. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


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

def additional_details
  @additional_details
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 38

def compartment_id
  @compartment_id
end

#component_name ⇒ String

[Required] The name of the external cluster.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 34

def component_name
  @component_name
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>>) 


110
111
112
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 110

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 30

def display_name
  @display_name
end

#external_connector_id ⇒ String

The OCID of the external connector.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 46

def external_connector_id
  @external_connector_id
end

#external_db_system_id ⇒ String

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

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 42

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


103
104
105
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 103

def freeform_tags
  @freeform_tags
end

#grid_home ⇒ String

The directory in which Oracle Grid Infrastructure is installed.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 50

def grid_home
  @grid_home
end

#id ⇒ String

[Required] The OCID of the external cluster.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 26

def id
  @id
end

#is_flex_cluster ⇒ BOOLEAN

Indicates whether the cluster is Oracle Flex Cluster or not.

Returns:

  • (BOOLEAN) 


54
55
56
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 54

def is_flex_cluster
  @is_flex_cluster
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#network_configurations ⇒ Array<OCI::DatabaseManagement::Models::ExternalClusterNetworkConfiguration>

The list of network address configurations of the external cluster.

Returns:



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

def network_configurations
  @network_configurations
end

#ocr_file_location ⇒ String

The location of the Oracle Cluster Registry (OCR).

Returns:

  • (String) 


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

def ocr_file_location
  @ocr_file_location
end

#scan_configurations ⇒ Array<OCI::DatabaseManagement::Models::ExternalClusterScanListenerConfiguration>

The list of Single Client Access Name (SCAN) configurations of the external cluster.

Returns:



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

def scan_configurations
  @scan_configurations
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>>) 


119
120
121
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 119

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the external cluster was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the external cluster was last updated.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#version ⇒ String

The cluster version.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 96

def version
  @version
end

#vip_configurations ⇒ Array<OCI::DatabaseManagement::Models::ExternalClusterVipConfiguration>

The list of Virtual IP (VIP) configurations of the external cluster.

Returns:



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

def vip_configurations
  @vip_configurations
end

Class Method Details

.attribute_map ⇒ Object

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 122

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'component_name': :'componentName',
    'compartment_id': :'compartmentId',
    'external_db_system_id': :'externalDbSystemId',
    'external_connector_id': :'externalConnectorId',
    'grid_home': :'gridHome',
    'is_flex_cluster': :'isFlexCluster',
    'additional_details': :'additionalDetails',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'network_configurations': :'networkConfigurations',
    'vip_configurations': :'vipConfigurations',
    'scan_configurations': :'scanConfigurations',
    'ocr_file_location': :'ocrFileLocation',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'version': :'version',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 151

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'component_name': :'String',
    'compartment_id': :'String',
    'external_db_system_id': :'String',
    'external_connector_id': :'String',
    'grid_home': :'String',
    'is_flex_cluster': :'BOOLEAN',
    'additional_details': :'Hash<String, String>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'network_configurations': :'Array<OCI::DatabaseManagement::Models::ExternalClusterNetworkConfiguration>',
    'vip_configurations': :'Array<OCI::DatabaseManagement::Models::ExternalClusterVipConfiguration>',
    'scan_configurations': :'Array<OCI::DatabaseManagement::Models::ExternalClusterScanListenerConfiguration>',
    'ocr_file_location': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'version': :'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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 351

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_db_system_id == other.external_db_system_id &&
    external_connector_id == other.external_connector_id &&
    grid_home == other.grid_home &&
    is_flex_cluster == other.is_flex_cluster &&
    additional_details == other.additional_details &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    network_configurations == other.network_configurations &&
    vip_configurations == other.vip_configurations &&
    scan_configurations == other.scan_configurations &&
    ocr_file_location == other.ocr_file_location &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    version == other.version &&
    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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 401

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


381
382
383
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 381

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



390
391
392
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 390

def hash
  [id, display_name, component_name, compartment_id, external_db_system_id, external_connector_id, grid_home, is_flex_cluster, additional_details, lifecycle_state, lifecycle_details, network_configurations, vip_configurations, scan_configurations, ocr_file_location, time_created, time_updated, version, 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



434
435
436
437
438
439
440
441
442
443
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 434

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



428
429
430
 
# File 'lib/oci/database_management/models/external_cluster.rb', line 428

def to_s
  to_hash.to_s
end