Class: OCI::Database::Models::ExascaleDbStorageVault

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/exascale_db_storage_vault.rb

Overview

Details of the Exadata Database Storage Vault.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ATTACHED_SHAPE_ATTRIBUTES_ENUM =
[
  ATTACHED_SHAPE_ATTRIBUTES_SMART_STORAGE = 'SMART_STORAGE'.freeze,
  ATTACHED_SHAPE_ATTRIBUTES_BLOCK_STORAGE = 'BLOCK_STORAGE'.freeze,
  ATTACHED_SHAPE_ATTRIBUTES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExascaleDbStorageVault

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 219

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

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

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

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

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

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

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

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

  self.vm_cluster_count = attributes[:'vmClusterCount'] if attributes[:'vmClusterCount']

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

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

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

  self.exadata_infrastructure_id = attributes[:'exadataInfrastructureId'] if attributes[:'exadataInfrastructureId']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

  self.high_capacity_database_storage = attributes[:'highCapacityDatabaseStorage'] if attributes[:'highCapacityDatabaseStorage']

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

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

  self.additional_flash_cache_in_percent = attributes[:'additionalFlashCacheInPercent'] if attributes[:'additionalFlashCacheInPercent']

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

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

  self.subscription_id = attributes[:'subscriptionId'] if attributes[:'subscriptionId']

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

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

  self.is_autoscale_enabled = attributes[:'isAutoscaleEnabled'] unless attributes[:'isAutoscaleEnabled'].nil?

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

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

  self.autoscale_limit_in_gbs = attributes[:'autoscaleLimitInGBs'] if attributes[:'autoscaleLimitInGBs']

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

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

  self.attached_shape_attributes = attributes[:'attachedShapeAttributes'] if attributes[:'attachedShapeAttributes']

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

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

Instance Attribute Details

#additional_flash_cache_in_percentInteger

The size of additional Flash Cache in percentage of High Capacity database storage.

Returns:

  • (Integer)


108
109
110
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 108

def additional_flash_cache_in_percent
  @additional_flash_cache_in_percent
end

#attached_shape_attributesArray<String>

The shapeAttribute of the Exadata VM cluster(s) associated with the Exadata Database Storage Vault.

Returns:

  • (Array<String>)


129
130
131
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 129

def attached_shape_attributes
  @attached_shape_attributes
end

#autoscale_limit_in_gbsInteger

The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault

Returns:

  • (Integer)


124
125
126
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 124

def autoscale_limit_in_gbs
  @autoscale_limit_in_gbs
end

#availability_domainString

[Required] The name of the availability domain in which the Exadata Database Storage Vault is located.

Returns:

  • (String)


39
40
41
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 39

def availability_domain
  @availability_domain
end

#cluster_placement_group_idString

The OCID of the cluster placement group of the Exadata Infrastructure or Db System.

Returns:

  • (String)


112
113
114
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 112

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


35
36
37
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 35

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

  • (Hash<String, Hash<String, Object>>)


89
90
91
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 89

def defined_tags
  @defined_tags
end

#descriptionString

Exadata Database Storage Vault description.

Returns:

  • (String)


51
52
53
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 51

def description
  @description
end

#display_nameString

[Required] The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique.

Returns:

  • (String)


47
48
49
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 47

def display_name
  @display_name
end

#exadata_infrastructure_idString

The OCID of the Exadata infrastructure.

Returns:

  • (String)


93
94
95
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 93

def exadata_infrastructure_id
  @exadata_infrastructure_id
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


83
84
85
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 83

def freeform_tags
  @freeform_tags
end

#high_capacity_database_storageOCI::Database::Models::ExascaleDbStorageDetails

This attribute is required.



103
104
105
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 103

def high_capacity_database_storage
  @high_capacity_database_storage
end

#idString

[Required] The OCID of the Exadata Database Storage Vault.

Returns:

  • (String)


31
32
33
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 31

def id
  @id
end

#is_autoscale_enabledBOOLEAN

Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is FALSE.

Returns:

  • (BOOLEAN)


120
121
122
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 120

def is_autoscale_enabled
  @is_autoscale_enabled
end

#lifecycle_detailsString

Additional information about the current lifecycle state.

Returns:

  • (String)


59
60
61
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 59

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The current state of the Exadata Database Storage Vault.

Returns:

  • (String)


43
44
45
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#subscription_idString

The OCID of the subscription with which resource needs to be associated with.

Returns:

  • (String)


116
117
118
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 116

def subscription_id
  @subscription_id
end

#system_tagsHash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

  • (Hash<String, Hash<String, Object>>)


99
100
101
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 99

def system_tags
  @system_tags
end

#time_createdDateTime

The date and time that the Exadata Database Storage Vault was created.

Returns:

  • (DateTime)


55
56
57
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 55

def time_created
  @time_created
end

#time_zoneString

The time zone that you want to use for the Exadata Database Storage Vault. For details, see Time Zones.

Returns:

  • (String)


64
65
66
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 64

def time_zone
  @time_zone
end

#vm_cluster_countInteger

The number of Exadata VM clusters used the Exadata Database Storage Vault.

Returns:

  • (Integer)


75
76
77
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 75

def vm_cluster_count
  @vm_cluster_count
end

#vm_cluster_idsArray<String>

The List of Exadata VM cluster on Exascale Infrastructure OCIDs Note: If Exadata Database Storage Vault is not used for any Exadata VM cluster on Exascale Infrastructure, this list is empty.

Returns:

  • (Array<String>)


70
71
72
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 70

def vm_cluster_ids
  @vm_cluster_ids
end

Class Method Details

.attribute_mapObject

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



132
133
134
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
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 132

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'lifecycle_state': :'lifecycleState',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'lifecycle_details': :'lifecycleDetails',
    'time_zone': :'timeZone',
    'vm_cluster_ids': :'vmClusterIds',
    'vm_cluster_count': :'vmClusterCount',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'exadata_infrastructure_id': :'exadataInfrastructureId',
    'system_tags': :'systemTags',
    'high_capacity_database_storage': :'highCapacityDatabaseStorage',
    'additional_flash_cache_in_percent': :'additionalFlashCacheInPercent',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'subscription_id': :'subscriptionId',
    'is_autoscale_enabled': :'isAutoscaleEnabled',
    'autoscale_limit_in_gbs': :'autoscaleLimitInGBs',
    'attached_shape_attributes': :'attachedShapeAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 162

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'availability_domain': :'String',
    'lifecycle_state': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'lifecycle_details': :'String',
    'time_zone': :'String',
    'vm_cluster_ids': :'Array<String>',
    'vm_cluster_count': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'exadata_infrastructure_id': :'String',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'high_capacity_database_storage': :'OCI::Database::Models::ExascaleDbStorageDetails',
    'additional_flash_cache_in_percent': :'Integer',
    'cluster_placement_group_id': :'String',
    'subscription_id': :'String',
    'is_autoscale_enabled': :'BOOLEAN',
    'autoscale_limit_in_gbs': :'Integer',
    'attached_shape_attributes': :'Array<String>'
    # 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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 390

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    lifecycle_state == other.lifecycle_state &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    lifecycle_details == other.lifecycle_details &&
    time_zone == other.time_zone &&
    vm_cluster_ids == other.vm_cluster_ids &&
    vm_cluster_count == other.vm_cluster_count &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    exadata_infrastructure_id == other.exadata_infrastructure_id &&
    system_tags == other.system_tags &&
    high_capacity_database_storage == other.high_capacity_database_storage &&
    additional_flash_cache_in_percent == other.additional_flash_cache_in_percent &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    subscription_id == other.subscription_id &&
    is_autoscale_enabled == other.is_autoscale_enabled &&
    autoscale_limit_in_gbs == other.autoscale_limit_in_gbs &&
    attached_shape_attributes == other.attached_shape_attributes
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



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 441

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


421
422
423
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 421

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



430
431
432
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 430

def hash
  [id, compartment_id, availability_domain, lifecycle_state, display_name, description, time_created, lifecycle_details, time_zone, vm_cluster_ids, vm_cluster_count, freeform_tags, defined_tags, exadata_infrastructure_id, system_tags, high_capacity_database_storage, additional_flash_cache_in_percent, cluster_placement_group_id, subscription_id, is_autoscale_enabled, autoscale_limit_in_gbs, attached_shape_attributes].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



474
475
476
477
478
479
480
481
482
483
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 474

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



468
469
470
# File 'lib/oci/database/models/exascale_db_storage_vault.rb', line 468

def to_s
  to_hash.to_s
end