Class: OCI::DistributedDatabase::Models::CreateDistributedDatabaseDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/distributed_database/models/create_distributed_database_details.rb

Overview

Details required for creation of the Globally distributed database.

Constant Summary collapse

SHARDING_METHOD_ENUM = 
[
  SHARDING_METHOD_USER = 'USER'.freeze,
  SHARDING_METHOD_SYSTEM = 'SYSTEM'.freeze
].freeze
REPLICATION_METHOD_ENUM = 
[
  REPLICATION_METHOD_RAFT = 'RAFT'.freeze,
  REPLICATION_METHOD_DG = 'DG'.freeze
].freeze
DB_DEPLOYMENT_TYPE_ENUM = 
[
  DB_DEPLOYMENT_TYPE_EXADB_XS = 'EXADB_XS'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDistributedDatabaseDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 219

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

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

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

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

  self.private_endpoint_ids = attributes[:'privateEndpointIds'] if attributes[:'privateEndpointIds']

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

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

  self.sharding_method = attributes[:'shardingMethod'] if attributes[:'shardingMethod']

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

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

  self.character_set = attributes[:'characterSet'] if attributes[:'characterSet']

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

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

  self.ncharacter_set = attributes[:'ncharacterSet'] if attributes[:'ncharacterSet']

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

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

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

  self.listener_port = attributes[:'listenerPort'] if attributes[:'listenerPort']

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

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

  self.listener_port_tls = attributes[:'listenerPortTls'] if attributes[:'listenerPortTls']

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

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

  self.ons_port_local = attributes[:'onsPortLocal'] if attributes[:'onsPortLocal']

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

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

  self.ons_port_remote = attributes[:'onsPortRemote'] if attributes[:'onsPortRemote']

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

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

  self.replication_method = attributes[:'replicationMethod'] if attributes[:'replicationMethod']

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

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

  self.replication_factor = attributes[:'replicationFactor'] if attributes[:'replicationFactor']

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

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

  self.replication_unit = attributes[:'replicationUnit'] if attributes[:'replicationUnit']

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

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

  self.db_deployment_type = attributes[:'dbDeploymentType'] if attributes[:'dbDeploymentType']

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

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

  self.shard_details = attributes[:'shardDetails'] if attributes[:'shardDetails']

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

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

  self.catalog_details = attributes[:'catalogDetails'] if attributes[:'catalogDetails']

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

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

  self.gsm_ssh_public_key = attributes[:'gsmSshPublicKey'] if attributes[:'gsmSshPublicKey']

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

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

  self.db_backup_config = attributes[:'dbBackupConfig'] if attributes[:'dbBackupConfig']

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

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

  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

#catalog_details ⇒ Array<OCI::DistributedDatabase::Models::CreateDistributedDatabaseCatalogDetails>

[Required] Collection of catalog for the Globally distributed database.

Returns:



107
108
109
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 107

def catalog_details
  @catalog_details
end

#character_set ⇒ String

[Required] The character set for the database.

Returns:

  • (String) 


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

def character_set
  @character_set
end

#chunks ⇒ Integer

The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.

Returns:

  • (Integer) 


63
64
65
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 63

def chunks
  @chunks
end

#compartment_id ⇒ String

[Required] The OCID of the Globally distributed database compartment.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 27

def compartment_id
  @compartment_id
end

#database_version ⇒ String

[Required] Oracle Database version for the shards and catalog used in Globally distributed database.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 35

def database_version
  @database_version
end

#db_backup_config ⇒ OCI::DistributedDatabase::Models::DistributedDbBackupConfig

Returns:



114
115
116
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 114

def db_backup_config
  @db_backup_config
end

#db_deployment_type ⇒ String

[Required] The distributed database deployment type.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 99

def db_deployment_type
  @db_deployment_type
end

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

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

Returns:

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


126
127
128
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 126

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The display name of the Globally distributed database.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 31

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. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


120
121
122
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 120

def freeform_tags
  @freeform_tags
end

#gsm_ssh_public_key ⇒ String

The SSH public key for Global service manager instances.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 111

def gsm_ssh_public_key
  @gsm_ssh_public_key
end

#listener_port ⇒ Integer

[Required] The listener port number for the Globally distributed database.

Returns:

  • (Integer) 


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

def listener_port
  @listener_port
end

#listener_port_tls ⇒ Integer

The TLS listener port number for Globally distributed database.

Returns:

  • (Integer) 


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

def listener_port_tls
  @listener_port_tls
end

#ncharacter_set ⇒ String

[Required] The national character set for the database.

Returns:

  • (String) 


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

def ncharacter_set
  @ncharacter_set
end

#ons_port_local ⇒ Integer

[Required] Ons local port number.

Returns:

  • (Integer) 


75
76
77
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 75

def ons_port_local
  @ons_port_local
end

#ons_port_remote ⇒ Integer

[Required] Ons remote port number.

Returns:

  • (Integer) 


79
80
81
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 79

def ons_port_remote
  @ons_port_remote
end

#prefix ⇒ String

[Required] Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 41

def prefix
  @prefix
end

#private_endpoint_ids ⇒ Array<String>

[Required] The collection of OCID of the private endpoint associated with Globally distributed autonomous database.

Returns:

  • (Array<String>) 


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

def private_endpoint_ids
  @private_endpoint_ids
end

#replication_factor ⇒ Integer

The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.

Returns:

  • (Integer) 


90
91
92
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 90

def replication_factor
  @replication_factor
end

#replication_method ⇒ String

The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 85

def replication_method
  @replication_method
end

#replication_unit ⇒ Integer

For RAFT replication based Globally distributed database, the value should be atleast twice the number of shards.

Returns:

  • (Integer) 


94
95
96
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 94

def replication_unit
  @replication_unit
end

#shard_details ⇒ Array<OCI::DistributedDatabase::Models::CreateDistributedDatabaseShardDetails>

[Required] Collection of shards for the Globally distributed database.

Returns:



103
104
105
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 103

def shard_details
  @shard_details
end

#sharding_method ⇒ String

[Required] Sharding Methods for the Globally distributed database.

Returns:

  • (String) 


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

def sharding_method
  @sharding_method
end

Class Method Details

.attribute_map ⇒ Object

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



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
155
156
157
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 129

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'database_version': :'databaseVersion',
    'prefix': :'prefix',
    'private_endpoint_ids': :'privateEndpointIds',
    'sharding_method': :'shardingMethod',
    'character_set': :'characterSet',
    'ncharacter_set': :'ncharacterSet',
    'chunks': :'chunks',
    'listener_port': :'listenerPort',
    'listener_port_tls': :'listenerPortTls',
    'ons_port_local': :'onsPortLocal',
    'ons_port_remote': :'onsPortRemote',
    'replication_method': :'replicationMethod',
    'replication_factor': :'replicationFactor',
    'replication_unit': :'replicationUnit',
    'db_deployment_type': :'dbDeploymentType',
    'shard_details': :'shardDetails',
    'catalog_details': :'catalogDetails',
    'gsm_ssh_public_key': :'gsmSshPublicKey',
    'db_backup_config': :'dbBackupConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'database_version': :'String',
    'prefix': :'String',
    'private_endpoint_ids': :'Array<String>',
    'sharding_method': :'String',
    'character_set': :'String',
    'ncharacter_set': :'String',
    'chunks': :'Integer',
    'listener_port': :'Integer',
    'listener_port_tls': :'Integer',
    'ons_port_local': :'Integer',
    'ons_port_remote': :'Integer',
    'replication_method': :'String',
    'replication_factor': :'Integer',
    'replication_unit': :'Integer',
    'db_deployment_type': :'String',
    'shard_details': :'Array<OCI::DistributedDatabase::Models::CreateDistributedDatabaseShardDetails>',
    'catalog_details': :'Array<OCI::DistributedDatabase::Models::CreateDistributedDatabaseCatalogDetails>',
    'gsm_ssh_public_key': :'String',
    'db_backup_config': :'OCI::DistributedDatabase::Models::DistributedDbBackupConfig',
    '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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 387

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    database_version == other.database_version &&
    prefix == other.prefix &&
    private_endpoint_ids == other.private_endpoint_ids &&
    sharding_method == other.sharding_method &&
    character_set == other.character_set &&
    ncharacter_set == other.ncharacter_set &&
    chunks == other.chunks &&
    listener_port == other.listener_port &&
    listener_port_tls == other.listener_port_tls &&
    ons_port_local == other.ons_port_local &&
    ons_port_remote == other.ons_port_remote &&
    replication_method == other.replication_method &&
    replication_factor == other.replication_factor &&
    replication_unit == other.replication_unit &&
    db_deployment_type == other.db_deployment_type &&
    shard_details == other.shard_details &&
    catalog_details == other.catalog_details &&
    gsm_ssh_public_key == other.gsm_ssh_public_key &&
    db_backup_config == other.db_backup_config &&
    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



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 439

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


419
420
421
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 419

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



428
429
430
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 428

def hash
  [compartment_id, display_name, database_version, prefix, private_endpoint_ids, sharding_method, character_set, ncharacter_set, chunks, listener_port, listener_port_tls, ons_port_local, ons_port_remote, replication_method, replication_factor, replication_unit, db_deployment_type, shard_details, catalog_details, gsm_ssh_public_key, db_backup_config, 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



472
473
474
475
476
477
478
479
480
481
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 472

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



466
467
468
 
# File 'lib/oci/distributed_database/models/create_distributed_database_details.rb', line 466

def to_s
  to_hash.to_s
end