Class: OCI::GloballyDistributedDatabase::Models::DedicatedShardedDatabase

Inherits:
ShardedDatabase
  • Object
show all
Defined in:
lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb

Overview

Details of ATP-D based sharded database.

Constant Summary collapse

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

Constants inherited from ShardedDatabase

ShardedDatabase::DB_DEPLOYMENT_TYPE_ENUM, ShardedDatabase::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ShardedDatabase

#compartment_id, #db_deployment_type, #defined_tags, #display_name, #freeform_tags, #id, #lifecycle_state, #lifecycle_state_details, #system_tags, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ShardedDatabase

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DedicatedShardedDatabase

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 209

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

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

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

  self.connection_strings = attributes[:'connectionStrings'] if attributes[:'connectionStrings']

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

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

  self.time_zone = attributes[:'timeZone'] if attributes[:'timeZone']

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

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

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

  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::DedicatedCatalogDetails>

Details of ATP-D based catalogs.

Returns:



99
100
101
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 99

def catalog_details
  @catalog_details
end

#character_set ⇒ String

[Required] The character set for the database.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 34

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) 


44
45
46
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 44

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) 


30
31
32
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 30

def cluster_certificate_common_name
  @cluster_certificate_common_name
end

#connection_strings ⇒ OCI::GloballyDistributedDatabase::Models::ConnectionString

Returns:



83
84
85
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 83

def connection_strings
  @connection_strings
end

#db_version ⇒ String

[Required] Oracle Database version number.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 56

def db_version
  @db_version
end

#db_workload ⇒ String

Possible workload types.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 48

def db_workload
  @db_workload
end

#gsms ⇒ Array<OCI::GloballyDistributedDatabase::Models::GsmDetails>

Details of GSM instances for the sharded database.

Returns:



91
92
93
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 91

def gsms
  @gsms
end

#listener_port ⇒ Integer

The GSM listener port number.

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 60

def listener_port
  @listener_port
end

#listener_port_tls ⇒ Integer

The TLS listener port number for sharded database.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 64

def listener_port_tls
  @listener_port_tls
end

#ncharacter_set ⇒ String

[Required] The national character set for the database.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 38

def ncharacter_set
  @ncharacter_set
end

#ons_port_local ⇒ Integer

Ons local port number.

Returns:

  • (Integer) 


68
69
70
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 68

def ons_port_local
  @ons_port_local
end

#ons_port_remote ⇒ Integer

Ons remote port number.

Returns:

  • (Integer) 


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

def ons_port_remote
  @ons_port_remote
end

#prefix ⇒ String

[Required] Unique prefix for the sharded database.

Returns:

  • (String) 


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

def prefix
  @prefix
end

#private_endpoint ⇒ String

The OCID of private endpoint being used by the sharded database.

Returns:

  • (String) 


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

def private_endpoint
  @private_endpoint
end

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

Details of ATP-D based shards.

Returns:



95
96
97
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 95

def shard_details
  @shard_details
end

#sharding_method ⇒ String

[Required] Sharding Method.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 52

def sharding_method
  @sharding_method
end

#time_zone ⇒ String

Timezone associated with the sharded database.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 87

def time_zone
  @time_zone
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'db_deployment_type': :'dbDeploymentType',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'cluster_certificate_common_name': :'clusterCertificateCommonName',
    'character_set': :'characterSet',
    'ncharacter_set': :'ncharacterSet',
    'chunks': :'chunks',
    'db_workload': :'dbWorkload',
    'sharding_method': :'shardingMethod',
    'db_version': :'dbVersion',
    'listener_port': :'listenerPort',
    'listener_port_tls': :'listenerPortTls',
    'ons_port_local': :'onsPortLocal',
    'ons_port_remote': :'onsPortRemote',
    'prefix': :'prefix',
    'private_endpoint': :'privateEndpoint',
    'connection_strings': :'connectionStrings',
    'time_zone': :'timeZone',
    'gsms': :'gsms',
    'shard_details': :'shardDetails',
    'catalog_details': :'catalogDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



139
140
141
142
143
144
145
146
147
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
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 139

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'db_deployment_type': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'cluster_certificate_common_name': :'String',
    'character_set': :'String',
    'ncharacter_set': :'String',
    'chunks': :'Integer',
    'db_workload': :'String',
    'sharding_method': :'String',
    'db_version': :'String',
    'listener_port': :'Integer',
    'listener_port_tls': :'Integer',
    'ons_port_local': :'Integer',
    'ons_port_remote': :'Integer',
    'prefix': :'String',
    'private_endpoint': :'String',
    'connection_strings': :'OCI::GloballyDistributedDatabase::Models::ConnectionString',
    'time_zone': :'String',
    'gsms': :'Array<OCI::GloballyDistributedDatabase::Models::GsmDetails>',
    'shard_details': :'Array<OCI::GloballyDistributedDatabase::Models::DedicatedShardDetails>',
    'catalog_details': :'Array<OCI::GloballyDistributedDatabase::Models::DedicatedCatalogDetails>'
    # 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



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
379
380
381
382
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 349

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    db_deployment_type == other.db_deployment_type &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    cluster_certificate_common_name == other.cluster_certificate_common_name &&
    character_set == other.character_set &&
    ncharacter_set == other.ncharacter_set &&
    chunks == other.chunks &&
    db_workload == other.db_workload &&
    sharding_method == other.sharding_method &&
    db_version == other.db_version &&
    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 &&
    private_endpoint == other.private_endpoint &&
    connection_strings == other.connection_strings &&
    time_zone == other.time_zone &&
    gsms == other.gsms &&
    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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 407

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


387
388
389
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 387

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



396
397
398
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 396

def hash
  [id, compartment_id, db_deployment_type, display_name, time_created, time_updated, lifecycle_state, lifecycle_state_details, freeform_tags, defined_tags, system_tags, cluster_certificate_common_name, character_set, ncharacter_set, chunks, db_workload, sharding_method, db_version, listener_port, listener_port_tls, ons_port_local, ons_port_remote, prefix, private_endpoint, connection_strings, time_zone, gsms, 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



440
441
442
443
444
445
446
447
448
449
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 440

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



434
435
436
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database.rb', line 434

def to_s
  to_hash.to_s
end