Class: OCI::GloballyDistributedDatabase::Models::DedicatedShardDetails

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

Overview

Details of ATP-D based shard.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_DELETING = 'DELETING'.freeze,
  STATUS_DELETED = 'DELETED'.freeze,
  STATUS_UPDATING = 'UPDATING'.freeze,
  STATUS_CREATING = 'CREATING'.freeze,
  STATUS_CREATED = 'CREATED'.freeze,
  STATUS_READY_FOR_CONFIGURATION = 'READY_FOR_CONFIGURATION'.freeze,
  STATUS_CONFIGURED = 'CONFIGURED'.freeze,
  STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DedicatedShardDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
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
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 170

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

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

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

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

  self.compute_count = attributes[:'computeCount'] if attributes[:'computeCount']

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

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

  self.data_storage_size_in_gbs = attributes[:'dataStorageSizeInGbs'] if attributes[:'dataStorageSizeInGbs']

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

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

  self.shard_group = attributes[:'shardGroup'] if attributes[:'shardGroup']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.time_ssl_certificate_expires = attributes[:'timeSslCertificateExpires'] if attributes[:'timeSslCertificateExpires']

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

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

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

  self.shard_space = attributes[:'shardSpace'] if attributes[:'shardSpace']

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

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

  self.supporting_resource_id = attributes[:'supportingResourceId'] if attributes[:'supportingResourceId']

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

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

  self.container_database_id = attributes[:'containerDatabaseId'] if attributes[:'containerDatabaseId']

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

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

  self.container_database_parent_id = attributes[:'containerDatabaseParentId'] if attributes[:'containerDatabaseParentId']

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

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

  self.is_auto_scaling_enabled = attributes[:'isAutoScalingEnabled'] unless attributes[:'isAutoScalingEnabled'].nil?

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

  self.is_auto_scaling_enabled = attributes[:'is_auto_scaling_enabled'] unless attributes[:'is_auto_scaling_enabled'].nil?

  self.cloud_autonomous_vm_cluster_id = attributes[:'cloudAutonomousVmClusterId'] if attributes[:'cloudAutonomousVmClusterId']

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

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

  self.peer_cloud_autonomous_vm_cluster_id = attributes[:'peerCloudAutonomousVmClusterId'] if attributes[:'peerCloudAutonomousVmClusterId']

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

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

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

Instance Attribute Details

#cloud_autonomous_vm_cluster_id ⇒ String

[Required] Identifier of the primary cloudAutonomousVmCluster for the shard.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 86

def cloud_autonomous_vm_cluster_id
  @cloud_autonomous_vm_cluster_id
end

#compute_count ⇒ Float

[Required] The compute amount available to the underlying autonomous database associated with shard.

Returns:

  • (Float) 


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

def compute_count
  @compute_count
end

#container_database_id ⇒ String

Identifier of the underlying container database.

Returns:

  • (String) 


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

def container_database_id
  @container_database_id
end

#container_database_parent_id ⇒ String

Identifier of the underlying container database parent.

Returns:

  • (String) 


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

def container_database_parent_id
  @container_database_parent_id
end

#data_storage_size_in_gbs ⇒ Float

[Required] The data disk group size to be allocated in GBs.

Returns:

  • (Float) 


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

def data_storage_size_in_gbs
  @data_storage_size_in_gbs
end

#encryption_key_details ⇒ OCI::GloballyDistributedDatabase::Models::DedicatedShardOrCatalogEncryptionKeyDetails

Returns:



26
27
28
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 26

def encryption_key_details
  @encryption_key_details
end

#is_auto_scaling_enabled ⇒ BOOLEAN

[Required] Determines the auto-scaling mode.

Returns:

  • (BOOLEAN) 


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

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#metadata ⇒ Hash<String, Object>

Additional metadata related to shard's underlying supporting resource.

Returns:

  • (Hash<String, Object>) 


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

def metadata
  @metadata
end

#name ⇒ String

[Required] Name of the shard.

Returns:

  • (String) 


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

def name
  @name
end

#peer_cloud_autonomous_vm_cluster_id ⇒ String

Identifier of the peer cloudAutonomousVmCluster for the shard.

Returns:

  • (String) 


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

def peer_cloud_autonomous_vm_cluster_id
  @peer_cloud_autonomous_vm_cluster_id
end

#shard_group ⇒ String

[Required] Name of the shard-group to which the shard belongs.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 42

def shard_group
  @shard_group
end

#shard_space ⇒ String

Shard space name.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 62

def shard_space
  @shard_space
end

#status ⇒ String

[Required] Status of shard or catalog or gsm for the sharded database.

Returns:

  • (String) 


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

def status
  @status
end

#supporting_resource_id ⇒ String

Identifier of the underlying supporting resource.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 67

def supporting_resource_id
  @supporting_resource_id
end

#time_created ⇒ DateTime

[Required] The time the the shard was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_ssl_certificate_expires ⇒ DateTime

The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


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

def time_ssl_certificate_expires
  @time_ssl_certificate_expires
end

#time_updated ⇒ DateTime

[Required] The time the shard was last updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'encryption_key_details': :'encryptionKeyDetails',
    'name': :'name',
    'compute_count': :'computeCount',
    'data_storage_size_in_gbs': :'dataStorageSizeInGbs',
    'shard_group': :'shardGroup',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_ssl_certificate_expires': :'timeSslCertificateExpires',
    'status': :'status',
    'shard_space': :'shardSpace',
    'supporting_resource_id': :'supportingResourceId',
    'container_database_id': :'containerDatabaseId',
    'container_database_parent_id': :'containerDatabaseParentId',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled',
    'cloud_autonomous_vm_cluster_id': :'cloudAutonomousVmClusterId',
    'peer_cloud_autonomous_vm_cluster_id': :'peerCloudAutonomousVmClusterId',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 123

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'encryption_key_details': :'OCI::GloballyDistributedDatabase::Models::DedicatedShardOrCatalogEncryptionKeyDetails',
    'name': :'String',
    'compute_count': :'Float',
    'data_storage_size_in_gbs': :'Float',
    'shard_group': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_ssl_certificate_expires': :'DateTime',
    'status': :'String',
    'shard_space': :'String',
    'supporting_resource_id': :'String',
    'container_database_id': :'String',
    'container_database_parent_id': :'String',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'cloud_autonomous_vm_cluster_id': :'String',
    'peer_cloud_autonomous_vm_cluster_id': :'String',
    'metadata': :'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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 287

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

  self.class == other.class &&
    encryption_key_details == other.encryption_key_details &&
    name == other.name &&
    compute_count == other.compute_count &&
    data_storage_size_in_gbs == other.data_storage_size_in_gbs &&
    shard_group == other.shard_group &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_ssl_certificate_expires == other.time_ssl_certificate_expires &&
    status == other.status &&
    shard_space == other.shard_space &&
    supporting_resource_id == other.supporting_resource_id &&
    container_database_id == other.container_database_id &&
    container_database_parent_id == other.container_database_parent_id &&
    is_auto_scaling_enabled == other.is_auto_scaling_enabled &&
    cloud_autonomous_vm_cluster_id == other.cloud_autonomous_vm_cluster_id &&
    peer_cloud_autonomous_vm_cluster_id == other.peer_cloud_autonomous_vm_cluster_id &&
    metadata == other.metadata
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 333

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


313
314
315
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 313

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



322
323
324
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 322

def hash
  [encryption_key_details, name, compute_count, data_storage_size_in_gbs, shard_group, time_created, time_updated, time_ssl_certificate_expires, status, shard_space, supporting_resource_id, container_database_id, container_database_parent_id, is_auto_scaling_enabled, cloud_autonomous_vm_cluster_id, peer_cloud_autonomous_vm_cluster_id, metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 366

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



360
361
362
 
# File 'lib/oci/globally_distributed_database/models/dedicated_shard_details.rb', line 360

def to_s
  to_hash.to_s
end