Class: OCI::Core::Models::CreateVolumeDetails
- Inherits:
-
Object
- Object
- OCI::Core::Models::CreateVolumeDetails
- Defined in:
- lib/oci/core/models/create_volume_details.rb
Overview
The details of the volume to create. For CreateVolume operation, this field is required in the request, see create_volume.
Instance Attribute Summary collapse
-
#autotune_policies ⇒ Array<OCI::Core::Models::AutotunePolicy>
The list of autotune policies to be enabled for this volume.
-
#availability_domain ⇒ String
The availability domain of the volume.
-
#backup_policy_id ⇒ String
If provided, specifies the ID of the volume backup policy to assign to the newly created volume.
-
#block_volume_replicas ⇒ Array<OCI::Core::Models::BlockVolumeReplicaDetails>
The list of block volume replicas to be enabled for this volume in the specified destination availability domains.
-
#cluster_placement_group_id ⇒ String
The clusterPlacementGroup Id of the volume for volume placement.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the volume.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#is_auto_tune_enabled ⇒ BOOLEAN
Specifies whether the auto-tune performance is enabled for this volume.
-
#kms_key_id ⇒ String
The OCID of the Vault service key to assign as the master encryption key for the volume.
-
#size_in_gbs ⇒ Integer
The size of the volume in GBs.
-
#size_in_mbs ⇒ Integer
The size of the volume in MBs.
- #source_details ⇒ OCI::Core::Models::VolumeSourceDetails
-
#volume_backup_id ⇒ String
The OCID of the volume backup from which the data should be restored on the newly created volume.
-
#vpus_per_gb ⇒ Integer
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.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateVolumeDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CreateVolumeDetails
Initializes the object
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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/oci/core/models/create_volume_details.rb', line 187 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. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = 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.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.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.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.size_in_mbs = attributes[:'sizeInMBs'] if attributes[:'sizeInMBs'] raise 'You cannot provide both :sizeInMBs and :size_in_mbs' if attributes.key?(:'sizeInMBs') && attributes.key?(:'size_in_mbs') self.size_in_mbs = attributes[:'size_in_mbs'] if attributes[:'size_in_mbs'] 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.volume_backup_id = attributes[:'volumeBackupId'] if attributes[:'volumeBackupId'] raise 'You cannot provide both :volumeBackupId and :volume_backup_id' if attributes.key?(:'volumeBackupId') && attributes.key?(:'volume_backup_id') self.volume_backup_id = attributes[:'volume_backup_id'] if attributes[:'volume_backup_id'] 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.block_volume_replicas = attributes[:'blockVolumeReplicas'] if attributes[:'blockVolumeReplicas'] raise 'You cannot provide both :blockVolumeReplicas and :block_volume_replicas' if attributes.key?(:'blockVolumeReplicas') && attributes.key?(:'block_volume_replicas') self.block_volume_replicas = attributes[:'block_volume_replicas'] if attributes[:'block_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_policies ⇒ Array<OCI::Core::Models::AutotunePolicy>
The list of autotune policies to be enabled for this volume.
115 116 117 |
# File 'lib/oci/core/models/create_volume_details.rb', line 115 def autotune_policies @autotune_policies end |
#availability_domain ⇒ String
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
18 19 20 |
# File 'lib/oci/core/models/create_volume_details.rb', line 18 def availability_domain @availability_domain end |
#backup_policy_id ⇒ String
If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.
24 25 26 |
# File 'lib/oci/core/models/create_volume_details.rb', line 24 def backup_policy_id @backup_policy_id end |
#block_volume_replicas ⇒ Array<OCI::Core::Models::BlockVolumeReplicaDetails>
The list of block volume replicas to be enabled for this volume in the specified destination availability domains.
111 112 113 |
# File 'lib/oci/core/models/create_volume_details.rb', line 111 def block_volume_replicas @block_volume_replicas end |
#cluster_placement_group_id ⇒ String
The clusterPlacementGroup Id of the volume for volume placement.
79 80 81 |
# File 'lib/oci/core/models/create_volume_details.rb', line 79 def cluster_placement_group_id @cluster_placement_group_id end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the volume.
28 29 30 |
# File 'lib/oci/core/models/create_volume_details.rb', line 28 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<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\"}}
36 37 38 |
# File 'lib/oci/core/models/create_volume_details.rb', line 36 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
42 43 44 |
# File 'lib/oci/core/models/create_volume_details.rb', line 42 def display_name @display_name end |
#freeform_tags ⇒ Hash<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\"}
50 51 52 |
# File 'lib/oci/core/models/create_volume_details.rb', line 50 def @freeform_tags end |
#is_auto_tune_enabled ⇒ BOOLEAN
Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune.
105 106 107 |
# File 'lib/oci/core/models/create_volume_details.rb', line 105 def is_auto_tune_enabled @is_auto_tune_enabled end |
#kms_key_id ⇒ String
The OCID of the Vault service key to assign as the master encryption key for the volume.
56 57 58 |
# File 'lib/oci/core/models/create_volume_details.rb', line 56 def kms_key_id @kms_key_id end |
#size_in_gbs ⇒ Integer
The size of the volume in GBs.
83 84 85 |
# File 'lib/oci/core/models/create_volume_details.rb', line 83 def size_in_gbs @size_in_gbs end |
#size_in_mbs ⇒ Integer
The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.
89 90 91 |
# File 'lib/oci/core/models/create_volume_details.rb', line 89 def size_in_mbs @size_in_mbs end |
#source_details ⇒ OCI::Core::Models::VolumeSourceDetails
92 93 94 |
# File 'lib/oci/core/models/create_volume_details.rb', line 92 def source_details @source_details end |
#volume_backup_id ⇒ String
The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.
99 100 101 |
# File 'lib/oci/core/models/create_volume_details.rb', line 99 def volume_backup_id @volume_backup_id end |
#vpus_per_gb ⇒ Integer
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:
-
0
: Represents Lower Cost option. -
10
: Represents Balanced option. -
20
: Represents Higher Performance option. -
30
-120
: Represents the Ultra High Performance option.
For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
75 76 77 |
# File 'lib/oci/core/models/create_volume_details.rb', line 75 def vpus_per_gb @vpus_per_gb end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/oci/core/models/create_volume_details.rb', line 118 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', 'vpus_per_gb': :'vpusPerGB', 'cluster_placement_group_id': :'clusterPlacementGroupId', 'size_in_gbs': :'sizeInGBs', 'size_in_mbs': :'sizeInMBs', 'source_details': :'sourceDetails', 'volume_backup_id': :'volumeBackupId', 'is_auto_tune_enabled': :'isAutoTuneEnabled', 'block_volume_replicas': :'blockVolumeReplicas', 'autotune_policies': :'autotunePolicies' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/core/models/create_volume_details.rb', line 142 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', 'vpus_per_gb': :'Integer', 'cluster_placement_group_id': :'String', 'size_in_gbs': :'Integer', 'size_in_mbs': :'Integer', 'source_details': :'OCI::Core::Models::VolumeSourceDetails', 'volume_backup_id': :'String', 'is_auto_tune_enabled': :'BOOLEAN', 'block_volume_replicas': :'Array<OCI::Core::Models::BlockVolumeReplicaDetails>', 'autotune_policies': :'Array<OCI::Core::Models::AutotunePolicy>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/oci/core/models/create_volume_details.rb', line 297 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 && == other. && display_name == other.display_name && == other. && kms_key_id == other.kms_key_id && vpus_per_gb == other.vpus_per_gb && cluster_placement_group_id == other.cluster_placement_group_id && size_in_gbs == other.size_in_gbs && size_in_mbs == other.size_in_mbs && source_details == other.source_details && volume_backup_id == other.volume_backup_id && is_auto_tune_enabled == other.is_auto_tune_enabled && block_volume_replicas == other.block_volume_replicas && autotune_policies == other.autotune_policies end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
# File 'lib/oci/core/models/create_volume_details.rb', line 342 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
322 323 324 |
# File 'lib/oci/core/models/create_volume_details.rb', line 322 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
331 332 333 |
# File 'lib/oci/core/models/create_volume_details.rb', line 331 def hash [availability_domain, backup_policy_id, compartment_id, , display_name, , kms_key_id, vpus_per_gb, cluster_placement_group_id, size_in_gbs, size_in_mbs, source_details, volume_backup_id, is_auto_tune_enabled, block_volume_replicas, autotune_policies].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
375 376 377 378 379 380 381 382 383 384 |
# File 'lib/oci/core/models/create_volume_details.rb', line 375 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
369 370 371 |
# File 'lib/oci/core/models/create_volume_details.rb', line 369 def to_s to_hash.to_s end |