Class: OCI::GloballyDistributedDatabase::Models::DedicatedShardedDatabaseSummary

Inherits:
ShardedDatabaseSummary show all
Defined in:
lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb

Overview

Summary 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 ShardedDatabaseSummary

ShardedDatabaseSummary::DB_DEPLOYMENT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ShardedDatabaseSummary

#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 ShardedDatabaseSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DedicatedShardedDatabaseSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :lifecycle_state_details (String) —

    The value to assign to the #lifecycle_state_details proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags proprety

  • :replication_method (String) —

    The value to assign to the #replication_method property

  • :replication_factor (Integer) —

    The value to assign to the #replication_factor property

  • :replication_unit (Integer) —

    The value to assign to the #replication_unit property

  • :cluster_certificate_common_name (String) —

    The value to assign to the #cluster_certificate_common_name property

  • :db_workload (String) —

    The value to assign to the #db_workload property

  • :sharding_method (String) —

    The value to assign to the #sharding_method property

  • :character_set (String) —

    The value to assign to the #character_set property

  • :ncharacter_set (String) —

    The value to assign to the #ncharacter_set property

  • :chunks (Integer) —

    The value to assign to the #chunks property

  • :db_version (String) —

    The value to assign to the #db_version property

  • :listener_port (Integer) —

    The value to assign to the #listener_port property

  • :listener_port_tls (Integer) —

    The value to assign to the #listener_port_tls property

  • :ons_port_local (Integer) —

    The value to assign to the #ons_port_local property

  • :ons_port_remote (Integer) —

    The value to assign to the #ons_port_remote property

  • :prefix (String) —

    The value to assign to the #prefix property

  • :total_cpu_count (Integer) —

    The value to assign to the #total_cpu_count property

  • :total_data_storage_size_in_gbs (Float) —

    The value to assign to the #total_data_storage_size_in_gbs property



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
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 204

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

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

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

  self.total_data_storage_size_in_gbs = attributes[:'totalDataStorageSizeInGbs'] if attributes[:'totalDataStorageSizeInGbs']

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

  self.total_data_storage_size_in_gbs = attributes[:'total_data_storage_size_in_gbs'] if attributes[:'total_data_storage_size_in_gbs']
end

Instance Attribute Details

#character_set ⇒ String

[Required] The character set for the sharded database.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 55

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) 


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

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) 


43
44
45
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 43

def cluster_certificate_common_name
  @cluster_certificate_common_name
end

#db_version ⇒ String

Oracle Database version of the Autonomous Container Database.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 69

def db_version
  @db_version
end

#db_workload ⇒ String

[Required] Possible workload types.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 47

def db_workload
  @db_workload
end

#listener_port ⇒ Integer

The listener port number for the sharded database.

Returns:

  • (Integer) 


73
74
75
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 73

def listener_port
  @listener_port
end

#listener_port_tls ⇒ Integer

The TLS listener port number for sharded database.

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 77

def listener_port_tls
  @listener_port_tls
end

#ncharacter_set ⇒ String

[Required] The national character set for the sharded database.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 59

def ncharacter_set
  @ncharacter_set
end

#ons_port_local ⇒ Integer

Ons local port number.

Returns:

  • (Integer) 


81
82
83
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 81

def ons_port_local
  @ons_port_local
end

#ons_port_remote ⇒ Integer

Ons remote port number.

Returns:

  • (Integer) 


85
86
87
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 85

def ons_port_remote
  @ons_port_remote
end

#prefix ⇒ String

Name prefix for the sharded databases.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 89

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) 


32
33
34
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 32

def replication_factor
  @replication_factor
end

#replication_method ⇒ String

The Replication method for sharded database.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 27

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) 


36
37
38
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 36

def replication_unit
  @replication_unit
end

#sharding_method ⇒ String

[Required] Sharding Method.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 51

def sharding_method
  @sharding_method
end

#total_cpu_count ⇒ Integer

Total cpu count usage for shards and catalogs of the sharded database.

Returns:

  • (Integer) 


93
94
95
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 93

def total_cpu_count
  @total_cpu_count
end

#total_data_storage_size_in_gbs ⇒ Float

The aggregarted value of dataStorageSizeInGbs for all shards and catalogs.

Returns:

  • (Float) 


97
98
99
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 97

def total_data_storage_size_in_gbs
  @total_data_storage_size_in_gbs
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'replication_method': :'replicationMethod',
    'replication_factor': :'replicationFactor',
    'replication_unit': :'replicationUnit',
    'cluster_certificate_common_name': :'clusterCertificateCommonName',
    'db_workload': :'dbWorkload',
    'sharding_method': :'shardingMethod',
    'character_set': :'characterSet',
    'ncharacter_set': :'ncharacterSet',
    'chunks': :'chunks',
    'db_version': :'dbVersion',
    'listener_port': :'listenerPort',
    'listener_port_tls': :'listenerPortTls',
    'ons_port_local': :'onsPortLocal',
    'ons_port_remote': :'onsPortRemote',
    'prefix': :'prefix',
    'total_cpu_count': :'totalCpuCount',
    'total_data_storage_size_in_gbs': :'totalDataStorageSizeInGbs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
163
164
165
166
167
168
169
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 136

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>>',
    'replication_method': :'String',
    'replication_factor': :'Integer',
    'replication_unit': :'Integer',
    'cluster_certificate_common_name': :'String',
    'db_workload': :'String',
    'sharding_method': :'String',
    'character_set': :'String',
    'ncharacter_set': :'String',
    'chunks': :'Integer',
    'db_version': :'String',
    'listener_port': :'Integer',
    'listener_port_tls': :'Integer',
    'ons_port_local': :'Integer',
    'ons_port_remote': :'Integer',
    'prefix': :'String',
    'total_cpu_count': :'Integer',
    'total_data_storage_size_in_gbs': :'Float'
    # 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



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

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 &&
    replication_method == other.replication_method &&
    replication_factor == other.replication_factor &&
    replication_unit == other.replication_unit &&
    cluster_certificate_common_name == other.cluster_certificate_common_name &&
    db_workload == other.db_workload &&
    sharding_method == other.sharding_method &&
    character_set == other.character_set &&
    ncharacter_set == other.ncharacter_set &&
    chunks == other.chunks &&
    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 &&
    total_cpu_count == other.total_cpu_count &&
    total_data_storage_size_in_gbs == other.total_data_storage_size_in_gbs
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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 399

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


379
380
381
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 379

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



388
389
390
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 388

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, replication_method, replication_factor, replication_unit, cluster_certificate_common_name, db_workload, sharding_method, character_set, ncharacter_set, chunks, db_version, listener_port, listener_port_tls, ons_port_local, ons_port_remote, prefix, total_cpu_count, total_data_storage_size_in_gbs].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 432

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



426
427
428
 
# File 'lib/oci/globally_distributed_database/models/dedicated_sharded_database_summary.rb', line 426

def to_s
  to_hash.to_s
end