Class: OCI::DistributedDatabase::Models::DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster

Inherits:
DistributedDatabaseCatalog show all
Defined in:
lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb

Overview

Globally distributed database catalog based on ExaDbXs.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_DELETING = 'DELETING'.freeze,
  STATUS_DELETED = 'DELETED'.freeze,
  STATUS_UPDATING = 'UPDATING'.freeze,
  STATUS_CREATING = 'CREATING'.freeze,
  STATUS_CREATED = 'CREATED'.freeze,
  STATUS_READY_FOR_CONFIGURATION = 'READY_FOR_CONFIGURATION'.freeze,
  STATUS_CONFIGURED = 'CONFIGURED'.freeze,
  STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from DistributedDatabaseCatalog

OCI::DistributedDatabase::Models::DistributedDatabaseCatalog::SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DistributedDatabaseCatalog

#name, #source, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DistributedDatabaseCatalog

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



148
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
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 148

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['source'] = 'NEW_VAULT_AND_CLUSTER'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.db_home_id = attributes[:'dbHomeId'] if attributes[:'dbHomeId']

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

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

  self.shard_group = attributes[:'shardGroup'] if attributes[:'shardGroup']

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

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

  self.vault_id = attributes[:'vaultId'] if attributes[:'vaultId']

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

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

  self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

  self.kms_key_version_id = attributes[:'kmsKeyVersionId'] if attributes[:'kmsKeyVersionId']

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

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

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

  self.supporting_resource_id = attributes[:'supportingResourceId'] if attributes[:'supportingResourceId']

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

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

  self.container_database_id = attributes[:'containerDatabaseId'] if attributes[:'containerDatabaseId']

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

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

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.db_storage_vault_details = attributes[:'dbStorageVaultDetails'] if attributes[:'dbStorageVaultDetails']

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

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

  self.vm_cluster_details = attributes[:'vmClusterDetails'] if attributes[:'vmClusterDetails']

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

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

  self.peer_details = attributes[:'peerDetails'] if attributes[:'peerDetails']

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

The name of the availability domain that the distributed database catalog will be located in.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 61

def availability_domain
  @availability_domain
end

#container_database_id ⇒ String

the identifier of the container database for underlying supporting resource.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 57

def container_database_id
  @container_database_id
end

#db_home_id ⇒ String

The OCID of the Database Home.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 28

def db_home_id
  @db_home_id
end

#db_storage_vault_details ⇒ OCI::DistributedDatabase::Models::DistributedDbStorageVault

Returns:



64
65
66
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 64

def db_storage_vault_details
  @db_storage_vault_details
end

#kms_key_id ⇒ String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 40

def kms_key_id
  @kms_key_id
end

#kms_key_version_id ⇒ String

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 45

def kms_key_version_id
  @kms_key_version_id
end

#metadata ⇒ OCI::DistributedDatabase::Models::DistributedDbMetadata

Returns:



74
75
76
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 74

def metadata
  @metadata
end

#peer_details ⇒ Array<OCI::DistributedDatabase::Models::CatalogPeerWithExadbXsNewVaultAndCluster>

Peer details for the catalog.

Returns:



71
72
73
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 71

def peer_details
  @peer_details
end

#shard_group ⇒ String

[Required] The name of the shardGroup for the catalog.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 32

def shard_group
  @shard_group
end

#status ⇒ String

[Required] Status of EXADB_XS based catalog.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 49

def status
  @status
end

#supporting_resource_id ⇒ String

the identifier of the underlying supporting resource.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 53

def supporting_resource_id
  @supporting_resource_id
end

#vault_id ⇒ String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 36

def vault_id
  @vault_id
end

#vm_cluster_details ⇒ OCI::DistributedDatabase::Models::DistributedDbVmCluster

Returns:



67
68
69
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 67

def vm_cluster_details
  @vm_cluster_details
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source': :'source',
    'name': :'name',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'db_home_id': :'dbHomeId',
    'shard_group': :'shardGroup',
    'vault_id': :'vaultId',
    'kms_key_id': :'kmsKeyId',
    'kms_key_version_id': :'kmsKeyVersionId',
    'status': :'status',
    'supporting_resource_id': :'supportingResourceId',
    'container_database_id': :'containerDatabaseId',
    'availability_domain': :'availabilityDomain',
    'db_storage_vault_details': :'dbStorageVaultDetails',
    'vm_cluster_details': :'vmClusterDetails',
    'peer_details': :'peerDetails',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source': :'String',
    'name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'db_home_id': :'String',
    'shard_group': :'String',
    'vault_id': :'String',
    'kms_key_id': :'String',
    'kms_key_version_id': :'String',
    'status': :'String',
    'supporting_resource_id': :'String',
    'container_database_id': :'String',
    'availability_domain': :'String',
    'db_storage_vault_details': :'OCI::DistributedDatabase::Models::DistributedDbStorageVault',
    'vm_cluster_details': :'OCI::DistributedDatabase::Models::DistributedDbVmCluster',
    'peer_details': :'Array<OCI::DistributedDatabase::Models::CatalogPeerWithExadbXsNewVaultAndCluster>',
    'metadata': :'OCI::DistributedDatabase::Models::DistributedDbMetadata'
    # 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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 249

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

  self.class == other.class &&
    source == other.source &&
    name == other.name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    db_home_id == other.db_home_id &&
    shard_group == other.shard_group &&
    vault_id == other.vault_id &&
    kms_key_id == other.kms_key_id &&
    kms_key_version_id == other.kms_key_version_id &&
    status == other.status &&
    supporting_resource_id == other.supporting_resource_id &&
    container_database_id == other.container_database_id &&
    availability_domain == other.availability_domain &&
    db_storage_vault_details == other.db_storage_vault_details &&
    vm_cluster_details == other.vm_cluster_details &&
    peer_details == other.peer_details &&
    metadata == other.metadata
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 295

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


275
276
277
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 284

def hash
  [source, name, time_created, time_updated, db_home_id, shard_group, vault_id, kms_key_id, kms_key_version_id, status, supporting_resource_id, container_database_id, availability_domain, db_storage_vault_details, vm_cluster_details, peer_details, metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 328

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



322
323
324
 
# File 'lib/oci/distributed_database/models/distributed_database_catalog_with_exadb_xs_new_vault_and_cluster.rb', line 322

def to_s
  to_hash.to_s
end