Class: OCI::Core::Models::CreateVolumeDetails
- Inherits:
-
Object
- Object
- OCI::Core::Models::CreateVolumeDetails
- Defined in:
- lib/oci/core/models/create_volume_details.rb
Overview
CreateVolumeDetails model.
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
[Required] 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.
-
#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.
-
#kms_key_id ⇒ String
The OCID of the KMS key to be used 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
Specifies the volume source details for a new Block volume.
-
#volume_backup_id ⇒ String
The OCID of the volume backup from which the data should be restored on the newly created volume.
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
131 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 160 161 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 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/oci/core/models/create_volume_details.rb', line 131 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.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'] end |
Instance Attribute Details
#availability_domain ⇒ String
[Required] The availability domain of the volume.
Example: ‘Uocm:PHX-AD-1`
14 15 16 |
# File 'lib/oci/core/models/create_volume_details.rb', line 14 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.
20 21 22 |
# File 'lib/oci/core/models/create_volume_details.rb', line 20 def backup_policy_id @backup_policy_id end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the volume.
24 25 26 |
# File 'lib/oci/core/models/create_volume_details.rb', line 24 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
32 33 34 |
# File 'lib/oci/core/models/create_volume_details.rb', line 32 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.
38 39 40 |
# File 'lib/oci/core/models/create_volume_details.rb', line 38 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
46 47 48 |
# File 'lib/oci/core/models/create_volume_details.rb', line 46 def @freeform_tags end |
#kms_key_id ⇒ String
The OCID of the KMS key to be used as the master encryption key for the volume.
50 51 52 |
# File 'lib/oci/core/models/create_volume_details.rb', line 50 def kms_key_id @kms_key_id end |
#size_in_gbs ⇒ Integer
The size of the volume in GBs.
54 55 56 |
# File 'lib/oci/core/models/create_volume_details.rb', line 54 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.
60 61 62 |
# File 'lib/oci/core/models/create_volume_details.rb', line 60 def size_in_mbs @size_in_mbs end |
#source_details ⇒ OCI::Core::Models::VolumeSourceDetails
Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same availability domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.
67 68 69 |
# File 'lib/oci/core/models/create_volume_details.rb', line 67 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.
74 75 76 |
# File 'lib/oci/core/models/create_volume_details.rb', line 74 def volume_backup_id @volume_backup_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/oci/core/models/create_volume_details.rb', line 77 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', 'size_in_mbs': :'sizeInMBs', 'source_details': :'sourceDetails', 'volume_backup_id': :'volumeBackupId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/oci/core/models/create_volume_details.rb', line 96 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', 'size_in_mbs': :'Integer', 'source_details': :'OCI::Core::Models::VolumeSourceDetails', 'volume_backup_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/oci/core/models/create_volume_details.rb', line 211 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 && 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 end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/oci/core/models/create_volume_details.rb', line 251 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
231 232 233 |
# File 'lib/oci/core/models/create_volume_details.rb', line 231 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
240 241 242 |
# File 'lib/oci/core/models/create_volume_details.rb', line 240 def hash [availability_domain, backup_policy_id, compartment_id, , display_name, , kms_key_id, size_in_gbs, size_in_mbs, source_details, volume_backup_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
284 285 286 287 288 289 290 291 292 293 |
# File 'lib/oci/core/models/create_volume_details.rb', line 284 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
278 279 280 |
# File 'lib/oci/core/models/create_volume_details.rb', line 278 def to_s to_hash.to_s end |