Class: OCI::DistributedDatabase::Models::CreateDistributedDatabaseCatalogWithExadbXsDetails

Inherits:
CreateDistributedDatabaseCatalogDetails show all
Defined in:
lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb

Overview

Globally distributed database catalog based on exadbxs.

Constant Summary

Constants inherited from CreateDistributedDatabaseCatalogDetails

OCI::DistributedDatabase::Models::CreateDistributedDatabaseCatalogDetails::SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateDistributedDatabaseCatalogDetails

#source

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateDistributedDatabaseCatalogDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateDistributedDatabaseCatalogWithExadbXsDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 97

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

  attributes['source'] = 'EXADB_XS'

  super(attributes)

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

  self.vm_cluster_id = attributes[:'vmClusterId'] if attributes[:'vmClusterId']

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

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

  self.admin_password = attributes[:'adminPassword'] if attributes[:'adminPassword']

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

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

  self.peer_vm_cluster_ids = attributes[:'peerVmClusterIds'] if attributes[:'peerVmClusterIds']

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

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

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

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

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

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

Instance Attribute Details

#admin_password ⇒ String

[Required] The admin password for the cataog associated with Globally distributed database.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 18

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


42
43
44
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 42

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) 


47
48
49
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 47

def kms_key_version_id
  @kms_key_version_id
end

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

The details required for creation of the peer for the ExadbXs infrastructure based catalog.

Returns:



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

def peer_details
  @peer_details
end

#peer_vm_cluster_ids ⇒ Array<String>

This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails.

Returns:

  • (Array<String>) 


24
25
26
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 24

def peer_vm_cluster_ids
  @peer_vm_cluster_ids
end

#shard_space ⇒ String

The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 34

def shard_space
  @shard_space
end

#vault_id ⇒ String

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

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 38

def vault_id
  @vault_id
end

#vm_cluster_id ⇒ String

[Required] The OCID of the VmCluster.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 14

def vm_cluster_id
  @vm_cluster_id
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source': :'source',
    'vm_cluster_id': :'vmClusterId',
    'admin_password': :'adminPassword',
    'peer_vm_cluster_ids': :'peerVmClusterIds',
    'peer_details': :'peerDetails',
    'shard_space': :'shardSpace',
    'vault_id': :'vaultId',
    'kms_key_id': :'kmsKeyId',
    'kms_key_version_id': :'kmsKeyVersionId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 67

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source': :'String',
    'vm_cluster_id': :'String',
    'admin_password': :'String',
    'peer_vm_cluster_ids': :'Array<String>',
    'peer_details': :'Array<OCI::DistributedDatabase::Models::CreateCatalogPeerWithExadbXsDetails>',
    'shard_space': :'String',
    'vault_id': :'String',
    'kms_key_id': :'String',
    'kms_key_version_id': :'String'
    # 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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 163

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

  self.class == other.class &&
    source == other.source &&
    vm_cluster_id == other.vm_cluster_id &&
    admin_password == other.admin_password &&
    peer_vm_cluster_ids == other.peer_vm_cluster_ids &&
    peer_details == other.peer_details &&
    shard_space == other.shard_space &&
    vault_id == other.vault_id &&
    kms_key_id == other.kms_key_id &&
    kms_key_version_id == other.kms_key_version_id
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 201

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


181
182
183
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 181

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 190

def hash
  [source, vm_cluster_id, admin_password, peer_vm_cluster_ids, peer_details, shard_space, vault_id, kms_key_id, kms_key_version_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 234

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



228
229
230
 
# File 'lib/oci/distributed_database/models/create_distributed_database_catalog_with_exadb_xs_details.rb', line 228

def to_s
  to_hash.to_s
end