Class: OCI::Core::Models::CreateBootVolumeDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/create_boot_volume_details.rb

Overview

CreateBootVolumeDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBootVolumeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 165

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

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

  self.backup_policy_id = attributes[:'backup_policy_id'] if attributes[:'backup_policy_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.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.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.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.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

  self.size_in_gbs = attributes[:'sizeInGBs'] if attributes[:'sizeInGBs']

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

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

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

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

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

  self.source_details = attributes[:'sourceDetails'] if attributes[:'sourceDetails']

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

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

  self.is_auto_tune_enabled = attributes[:'isAutoTuneEnabled'] unless attributes[:'isAutoTuneEnabled'].nil?

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

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

  self.boot_volume_replicas = attributes[:'bootVolumeReplicas'] if attributes[:'bootVolumeReplicas']

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

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

  self.autotune_policies = attributes[:'autotunePolicies'] if attributes[:'autotunePolicies']

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

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

Instance Attribute Details

#autotune_policiesArray<OCI::Core::Models::AutotunePolicy>

The list of autotune policies to be enabled for this volume.



99
100
101
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 99

def autotune_policies
  @autotune_policies
end

#availability_domainString

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume.

Example: Uocm:PHX-AD-1

Returns:

  • (String)


16
17
18
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 16

def availability_domain
  @availability_domain
end

#backup_policy_idString

If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned.

Returns:

  • (String)


22
23
24
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 22

def backup_policy_id
  @backup_policy_id
end

#boot_volume_replicasArray<OCI::Core::Models::BootVolumeReplicaDetails>

The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.



95
96
97
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 95

def boot_volume_replicas
  @boot_volume_replicas
end

#cluster_placement_group_idString

The clusterPlacementGroup Id of the volume for volume placement.

Returns:

  • (String)


62
63
64
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 62

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_idString

[Required] The OCID of the compartment that contains the boot volume.

Returns:

  • (String)


26
27
28
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 26

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.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


34
35
36
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 34

def defined_tags
  @defined_tags
end

#display_nameString

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


40
41
42
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 40

def display_name
  @display_name
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>)


48
49
50
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 48

def freeform_tags
  @freeform_tags
end

#is_auto_tune_enabledBOOLEAN

Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.

Returns:

  • (BOOLEAN)


89
90
91
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 89

def is_auto_tune_enabled
  @is_auto_tune_enabled
end

#kms_key_idString

The OCID of the Vault service key to assign as the master encryption key for the boot volume.

Returns:

  • (String)


54
55
56
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 54

def kms_key_id
  @kms_key_id
end

#size_in_gbsInteger

The size of the volume in GBs.

Returns:

  • (Integer)


58
59
60
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 58

def size_in_gbs
  @size_in_gbs
end

#source_detailsOCI::Core::Models::BootVolumeSourceDetails

This attribute is required.



83
84
85
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 83

def source_details
  @source_details
end

#vpus_per_gbInteger

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

Allowed values:

  • 10: Represents the Balanced option.

  • 20: Represents the Higher Performance option.

  • 30-120: Represents the Ultra High Performance option.

For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.

Returns:

  • (Integer)


79
80
81
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 79

def vpus_per_gb
  @vpus_per_gb
end

Class Method Details

.attribute_mapObject

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'backup_policy_id': :'backupPolicyId',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'kms_key_id': :'kmsKeyId',
    'size_in_gbs': :'sizeInGBs',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'vpus_per_gb': :'vpusPerGB',
    'source_details': :'sourceDetails',
    'is_auto_tune_enabled': :'isAutoTuneEnabled',
    'boot_volume_replicas': :'bootVolumeReplicas',
    'autotune_policies': :'autotunePolicies'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'backup_policy_id': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'kms_key_id': :'String',
    'size_in_gbs': :'Integer',
    'cluster_placement_group_id': :'String',
    'vpus_per_gb': :'Integer',
    'source_details': :'OCI::Core::Models::BootVolumeSourceDetails',
    'is_auto_tune_enabled': :'BOOLEAN',
    'boot_volume_replicas': :'Array<OCI::Core::Models::BootVolumeReplicaDetails>',
    'autotune_policies': :'Array<OCI::Core::Models::AutotunePolicy>'
    # 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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 263

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    backup_policy_id == other.backup_policy_id &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    kms_key_id == other.kms_key_id &&
    size_in_gbs == other.size_in_gbs &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    vpus_per_gb == other.vpus_per_gb &&
    source_details == other.source_details &&
    is_auto_tune_enabled == other.is_auto_tune_enabled &&
    boot_volume_replicas == other.boot_volume_replicas &&
    autotune_policies == other.autotune_policies
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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 306

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


286
287
288
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 286

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



295
296
297
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 295

def hash
  [availability_domain, backup_policy_id, compartment_id, defined_tags, display_name, freeform_tags, kms_key_id, size_in_gbs, cluster_placement_group_id, vpus_per_gb, source_details, is_auto_tune_enabled, boot_volume_replicas, autotune_policies].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



339
340
341
342
343
344
345
346
347
348
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 339

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



333
334
335
# File 'lib/oci/core/models/create_boot_volume_details.rb', line 333

def to_s
  to_hash.to_s
end