Class: OCI::GloballyDistributedDatabase::Models::CreateDedicatedShardedDatabase

Inherits:
CreateShardedDatabaseDetails show all
Defined in:
lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb

Overview

Request details for creation of ATP-Dedicated based sharded database.

Constant Summary collapse

DB_WORKLOAD_ENUM = 
[
  DB_WORKLOAD_OLTP = 'OLTP'.freeze,
  DB_WORKLOAD_DW = 'DW'.freeze
].freeze
SHARDING_METHOD_ENUM = 
[
  SHARDING_METHOD_USER = 'USER'.freeze,
  SHARDING_METHOD_SYSTEM = 'SYSTEM'.freeze
].freeze

Constants inherited from CreateShardedDatabaseDetails

OCI::GloballyDistributedDatabase::Models::CreateShardedDatabaseDetails::DB_DEPLOYMENT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateShardedDatabaseDetails

#compartment_id, #db_deployment_type, #defined_tags, #display_name, #freeform_tags

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateShardedDatabaseDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateDedicatedShardedDatabase

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 191

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

  attributes['dbDeploymentType'] = 'DEDICATED'

  super(attributes)

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#catalog_details ⇒ Array<OCI::GloballyDistributedDatabase::Models::CreateDedicatedCatalogDetail>

[Required] Collection of ATP-Dedicated catalogs that needs to be created.

Returns:



102
103
104
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 102

def catalog_details
  @catalog_details
end

#character_set ⇒ String

[Required] The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 65

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) 


46
47
48
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 46

def chunks
  @chunks
end

#cluster_certificate_common_name ⇒ String

The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 40

def cluster_certificate_common_name
  @cluster_certificate_common_name
end

#db_version ⇒ String

[Required] Oracle Database version of the Autonomous Container Database.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 58

def db_version
  @db_version
end

#db_workload ⇒ String

[Required] Possible workload types.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 50

def db_workload
  @db_workload
end

#listener_port ⇒ Integer

[Required] The listener port number for sharded database.

Returns:

  • (Integer) 


76
77
78
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 76

def listener_port
  @listener_port
end

#listener_port_tls ⇒ Integer

[Required] The TLS listener port number for sharded database.

Returns:

  • (Integer) 


80
81
82
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 80

def listener_port_tls
  @listener_port_tls
end

#ncharacter_set ⇒ String

[Required] The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 72

def ncharacter_set
  @ncharacter_set
end

#ons_port_local ⇒ Integer

[Required] Ons port local for sharded database.

Returns:

  • (Integer) 


84
85
86
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 84

def ons_port_local
  @ons_port_local
end

#ons_port_remote ⇒ Integer

[Required] Ons remote port for sharded database.

Returns:

  • (Integer) 


88
89
90
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 88

def ons_port_remote
  @ons_port_remote
end

#prefix ⇒ String

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

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 94

def prefix
  @prefix
end

#replication_factor ⇒ Integer

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

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 29

def replication_factor
  @replication_factor
end

#replication_method ⇒ String

The Replication method for sharded database.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 24

def replication_method
  @replication_method
end

#replication_unit ⇒ Integer

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

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 33

def replication_unit
  @replication_unit
end

#shard_details ⇒ Array<OCI::GloballyDistributedDatabase::Models::CreateDedicatedShardDetail>

[Required] Collection of ATP-Dedicated shards that needs to be created.

Returns:



98
99
100
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 98

def shard_details
  @shard_details
end

#sharding_method ⇒ String

[Required] Sharding Method.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 54

def sharding_method
  @sharding_method
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 105

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'db_deployment_type': :'dbDeploymentType',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'replication_method': :'replicationMethod',
    'replication_factor': :'replicationFactor',
    'replication_unit': :'replicationUnit',
    'cluster_certificate_common_name': :'clusterCertificateCommonName',
    'chunks': :'chunks',
    'db_workload': :'dbWorkload',
    'sharding_method': :'shardingMethod',
    'db_version': :'dbVersion',
    'character_set': :'characterSet',
    'ncharacter_set': :'ncharacterSet',
    'listener_port': :'listenerPort',
    'listener_port_tls': :'listenerPortTls',
    'ons_port_local': :'onsPortLocal',
    'ons_port_remote': :'onsPortRemote',
    'prefix': :'prefix',
    'shard_details': :'shardDetails',
    'catalog_details': :'catalogDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'db_deployment_type': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'replication_method': :'String',
    'replication_factor': :'Integer',
    'replication_unit': :'Integer',
    'cluster_certificate_common_name': :'String',
    'chunks': :'Integer',
    'db_workload': :'String',
    'sharding_method': :'String',
    'db_version': :'String',
    'character_set': :'String',
    'ncharacter_set': :'String',
    'listener_port': :'Integer',
    'listener_port_tls': :'Integer',
    'ons_port_local': :'Integer',
    'ons_port_remote': :'Integer',
    'prefix': :'String',
    'shard_details': :'Array<OCI::GloballyDistributedDatabase::Models::CreateDedicatedShardDetail>',
    'catalog_details': :'Array<OCI::GloballyDistributedDatabase::Models::CreateDedicatedCatalogDetail>'
    # 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



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
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 319

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    db_deployment_type == other.db_deployment_type &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    replication_method == other.replication_method &&
    replication_factor == other.replication_factor &&
    replication_unit == other.replication_unit &&
    cluster_certificate_common_name == other.cluster_certificate_common_name &&
    chunks == other.chunks &&
    db_workload == other.db_workload &&
    sharding_method == other.sharding_method &&
    db_version == other.db_version &&
    character_set == other.character_set &&
    ncharacter_set == other.ncharacter_set &&
    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 &&
    prefix == other.prefix &&
    shard_details == other.shard_details &&
    catalog_details == other.catalog_details
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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 370

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


350
351
352
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 350

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



359
360
361
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 359

def hash
  [compartment_id, db_deployment_type, display_name, freeform_tags, defined_tags, replication_method, replication_factor, replication_unit, cluster_certificate_common_name, chunks, db_workload, sharding_method, db_version, character_set, ncharacter_set, listener_port, listener_port_tls, ons_port_local, ons_port_remote, prefix, shard_details, catalog_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 403

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



397
398
399
 
# File 'lib/oci/globally_distributed_database/models/create_dedicated_sharded_database.rb', line 397

def to_s
  to_hash.to_s
end