Class: OCI::DistributedDatabase::Models::CreateDistributedAutonomousDatabaseDetails

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

Overview

Details required for creation of the Globally distributed autonomous database.

Constant Summary collapse

SHARDING_METHOD_ENUM =
[
  SHARDING_METHOD_USER = 'USER'.freeze,
  SHARDING_METHOD_SYSTEM = 'SYSTEM'.freeze
].freeze
DB_WORKLOAD_ENUM =
[
  DB_WORKLOAD_OLTP = 'OLTP'.freeze,
  DB_WORKLOAD_DW = 'DW'.freeze
].freeze
REPLICATION_METHOD_ENUM =
[
  REPLICATION_METHOD_RAFT = 'RAFT'.freeze,
  REPLICATION_METHOD_DG = 'DG'.freeze
].freeze
DB_DEPLOYMENT_TYPE_ENUM =
[
  DB_DEPLOYMENT_TYPE_ADB_D = 'ADB_D'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDistributedAutonomousDatabaseDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 243

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

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

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

  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.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_detailsArray<OCI::DistributedDatabase::Models::CreateDistributedAutonomousDatabaseCatalogDetails>

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



135
136
137
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 135

def catalog_details
  @catalog_details
end

#character_setString

[Required] The character set for the database.

Returns:

  • (String)


62
63
64
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 62

def character_set
  @character_set
end

#chunksInteger

Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed autonomous databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.

Returns:

  • (Integer)


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

def chunks
  @chunks
end

#compartment_idString

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

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#database_versionString

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

Returns:

  • (String)


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

def database_version
  @database_version
end

#db_backup_configOCI::DistributedDatabase::Models::DistributedAutonomousDbBackupConfig



138
139
140
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 138

def db_backup_config
  @db_backup_config
end

#db_deployment_typeString

[Required] The distributed autonomous database deployment type.

Returns:

  • (String)


127
128
129
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 127

def db_deployment_type
  @db_deployment_type
end

#db_workloadString

[Required] Possible workload types. Currently only OLTP workload type is supported.

Returns:

  • (String)


58
59
60
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 58

def db_workload
  @db_workload
end

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


150
151
152
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 150

def defined_tags
  @defined_tags
end

#display_nameString

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

Returns:

  • (String)


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

def display_name
  @display_name
end

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


144
145
146
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 144

def freeform_tags
  @freeform_tags
end

#listener_portInteger

[Required] The listener port number for the Globally distributed autonomous database. The listener port number has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database.

Returns:

  • (Integer)


81
82
83
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 81

def listener_port
  @listener_port
end

#listener_port_tlsInteger

The TLS listener port number for Globally distributed autonomous database. The TLS listener port number has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database. The listenerPortTls is mandatory for dedicated infrastructure based distributed autonomous databases.

Returns:

  • (Integer)


89
90
91
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 89

def listener_port_tls
  @listener_port_tls
end

#ncharacter_setString

[Required] The national character set for the database.

Returns:

  • (String)


66
67
68
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 66

def ncharacter_set
  @ncharacter_set
end

#ons_port_localInteger

[Required] Ons local port number for Globally distributed autonomous database. The onsPortLocal has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database.

Returns:

  • (Integer)


96
97
98
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 96

def ons_port_local
  @ons_port_local
end

#ons_port_remoteInteger

[Required] Ons remote port number for Globally distributed autonomous database. The onsPortRemote has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database.

Returns:

  • (Integer)


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

def ons_port_remote
  @ons_port_remote
end

#prefixString

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

Returns:

  • (String)


46
47
48
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 46

def prefix
  @prefix
end

#private_endpoint_idsArray<String>

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

Returns:

  • (Array<String>)


50
51
52
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 50

def private_endpoint_ids
  @private_endpoint_ids
end

#replication_factorInteger

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

Returns:

  • (Integer)


116
117
118
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 116

def replication_factor
  @replication_factor
end

#replication_methodString

The Replication method for Globally distributed autonomous database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.

Returns:

  • (String)


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

def replication_method
  @replication_method
end

#replication_unitInteger

The replication unit count for RAFT based distributed autonomous database. For RAFT replication based Globally distributed autonomous database, the value should be at least twice the number of shards.

Returns:

  • (Integer)


122
123
124
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 122

def replication_unit
  @replication_unit
end

#shard_detailsArray<OCI::DistributedDatabase::Models::CreateDistributedAutonomousDatabaseShardDetails>

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



131
132
133
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 131

def shard_details
  @shard_details
end

#sharding_methodString

[Required] Sharding Methods for the Globally distributed autonomous database.

Returns:

  • (String)


54
55
56
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 54

def sharding_method
  @sharding_method
end

Class Method Details

.attribute_mapObject

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



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

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',
    'db_workload': :'dbWorkload',
    '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',
    'db_backup_config': :'dbBackupConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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',
    'db_workload': :'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::CreateDistributedAutonomousDatabaseShardDetails>',
    'catalog_details': :'Array<OCI::DistributedDatabase::Models::CreateDistributedAutonomousDatabaseCatalogDetails>',
    'db_backup_config': :'OCI::DistributedDatabase::Models::DistributedAutonomousDbBackupConfig',
    '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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 419

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 &&
    db_workload == other.db_workload &&
    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 &&
    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



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 471

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


451
452
453
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 451

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



460
461
462
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 460

def hash
  [compartment_id, display_name, database_version, prefix, private_endpoint_ids, sharding_method, db_workload, 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, db_backup_config, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



504
505
506
507
508
509
510
511
512
513
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 504

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



498
499
500
# File 'lib/oci/distributed_database/models/create_distributed_autonomous_database_details.rb', line 498

def to_s
  to_hash.to_s
end