Class: OCI::Core::Models::VolumeAttachment
- Inherits:
-
Object
- Object
- OCI::Core::Models::VolumeAttachment
- Defined in:
- lib/oci/core/models/volume_attachment.rb
Overview
A base object for all types of attachments between a storage volume and an instance. For specific details about iSCSI attachments, see IScsiVolumeAttachment.
For general information about volume attachments, see Overview of Block Volume Storage.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
EmulatedVolumeAttachment, IScsiVolumeAttachment, ParavirtualizedVolumeAttachment
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ATTACHING = 'ATTACHING'.freeze, LIFECYCLE_STATE_ATTACHED = 'ATTACHED'.freeze, LIFECYCLE_STATE_DETACHING = 'DETACHING'.freeze, LIFECYCLE_STATE_DETACHED = 'DETACHED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#attachment_type ⇒ String
[Required] The type of volume attachment.
-
#availability_domain ⇒ String
[Required] The availability domain of an instance.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment.
-
#device ⇒ String
The device name.
-
#display_name ⇒ String
A user-friendly name.
-
#id ⇒ String
[Required] The OCID of the volume attachment.
-
#instance_id ⇒ String
[Required] The OCID of the instance the volume is attached to.
-
#is_pv_encryption_in_transit_enabled ⇒ BOOLEAN
Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not.
-
#is_read_only ⇒ BOOLEAN
Whether the attachment was created in read-only mode.
-
#is_shareable ⇒ BOOLEAN
Whether the attachment should be created in shareable mode.
-
#lifecycle_state ⇒ String
[Required] The current state of the volume attachment.
-
#time_created ⇒ DateTime
[Required] The date and time the volume was created, in the format defined by RFC3339.
-
#volume_id ⇒ String
[Required] The OCID of the volume.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.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 = {}) ⇒ VolumeAttachment
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 = {}) ⇒ VolumeAttachment
Initializes the object
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 |
# File 'lib/oci/core/models/volume_attachment.rb', line 169 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. = attributes[:'attachmentType'] if attributes[:'attachmentType'] raise 'You cannot provide both :attachmentType and :attachment_type' if attributes.key?(:'attachmentType') && attributes.key?(:'attachment_type') self. = attributes[:'attachment_type'] if attributes[:'attachment_type'] 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.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.device = attributes[:'device'] if attributes[:'device'] 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.id = attributes[:'id'] if attributes[:'id'] self.instance_id = attributes[:'instanceId'] if attributes[:'instanceId'] raise 'You cannot provide both :instanceId and :instance_id' if attributes.key?(:'instanceId') && attributes.key?(:'instance_id') self.instance_id = attributes[:'instance_id'] if attributes[:'instance_id'] self.is_read_only = attributes[:'isReadOnly'] unless attributes[:'isReadOnly'].nil? raise 'You cannot provide both :isReadOnly and :is_read_only' if attributes.key?(:'isReadOnly') && attributes.key?(:'is_read_only') self.is_read_only = attributes[:'is_read_only'] unless attributes[:'is_read_only'].nil? self.is_shareable = attributes[:'isShareable'] unless attributes[:'isShareable'].nil? raise 'You cannot provide both :isShareable and :is_shareable' if attributes.key?(:'isShareable') && attributes.key?(:'is_shareable') self.is_shareable = attributes[:'is_shareable'] unless attributes[:'is_shareable'].nil? 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.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.volume_id = attributes[:'volumeId'] if attributes[:'volumeId'] raise 'You cannot provide both :volumeId and :volume_id' if attributes.key?(:'volumeId') && attributes.key?(:'volume_id') self.volume_id = attributes[:'volume_id'] if attributes[:'volume_id'] self.is_pv_encryption_in_transit_enabled = attributes[:'isPvEncryptionInTransitEnabled'] unless attributes[:'isPvEncryptionInTransitEnabled'].nil? raise 'You cannot provide both :isPvEncryptionInTransitEnabled and :is_pv_encryption_in_transit_enabled' if attributes.key?(:'isPvEncryptionInTransitEnabled') && attributes.key?(:'is_pv_encryption_in_transit_enabled') self.is_pv_encryption_in_transit_enabled = attributes[:'is_pv_encryption_in_transit_enabled'] unless attributes[:'is_pv_encryption_in_transit_enabled'].nil? end |
Instance Attribute Details
#attachment_type ⇒ String
[Required] The type of volume attachment.
31 32 33 |
# File 'lib/oci/core/models/volume_attachment.rb', line 31 def @attachment_type end |
#availability_domain ⇒ String
[Required] The availability domain of an instance.
Example: Uocm:PHX-AD-1
38 39 40 |
# File 'lib/oci/core/models/volume_attachment.rb', line 38 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The OCID of the compartment.
42 43 44 |
# File 'lib/oci/core/models/volume_attachment.rb', line 42 def compartment_id @compartment_id end |
#device ⇒ String
The device name.
46 47 48 |
# File 'lib/oci/core/models/volume_attachment.rb', line 46 def device @device end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
Example: My volume attachment
54 55 56 |
# File 'lib/oci/core/models/volume_attachment.rb', line 54 def display_name @display_name end |
#id ⇒ String
[Required] The OCID of the volume attachment.
58 59 60 |
# File 'lib/oci/core/models/volume_attachment.rb', line 58 def id @id end |
#instance_id ⇒ String
[Required] The OCID of the instance the volume is attached to.
62 63 64 |
# File 'lib/oci/core/models/volume_attachment.rb', line 62 def instance_id @instance_id end |
#is_pv_encryption_in_transit_enabled ⇒ BOOLEAN
Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not.
89 90 91 |
# File 'lib/oci/core/models/volume_attachment.rb', line 89 def is_pv_encryption_in_transit_enabled @is_pv_encryption_in_transit_enabled end |
#is_read_only ⇒ BOOLEAN
Whether the attachment was created in read-only mode.
66 67 68 |
# File 'lib/oci/core/models/volume_attachment.rb', line 66 def is_read_only @is_read_only end |
#is_shareable ⇒ BOOLEAN
Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
70 71 72 |
# File 'lib/oci/core/models/volume_attachment.rb', line 70 def is_shareable @is_shareable end |
#lifecycle_state ⇒ String
[Required] The current state of the volume attachment.
74 75 76 |
# File 'lib/oci/core/models/volume_attachment.rb', line 74 def lifecycle_state @lifecycle_state end |
#time_created ⇒ DateTime
[Required] The date and time the volume was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
81 82 83 |
# File 'lib/oci/core/models/volume_attachment.rb', line 81 def time_created @time_created end |
#volume_id ⇒ String
[Required] The OCID of the volume.
85 86 87 |
# File 'lib/oci/core/models/volume_attachment.rb', line 85 def volume_id @volume_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/oci/core/models/volume_attachment.rb', line 92 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'attachment_type': :'attachmentType', 'availability_domain': :'availabilityDomain', 'compartment_id': :'compartmentId', 'device': :'device', 'display_name': :'displayName', 'id': :'id', 'instance_id': :'instanceId', 'is_read_only': :'isReadOnly', 'is_shareable': :'isShareable', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'volume_id': :'volumeId', 'is_pv_encryption_in_transit_enabled': :'isPvEncryptionInTransitEnabled' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
138 139 140 141 142 143 144 145 146 147 |
# File 'lib/oci/core/models/volume_attachment.rb', line 138 def self.get_subtype(object_hash) type = object_hash[:'attachmentType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Core::Models::IScsiVolumeAttachment' if type == 'iscsi' return 'OCI::Core::Models::EmulatedVolumeAttachment' if type == 'emulated' return 'OCI::Core::Models::ParavirtualizedVolumeAttachment' if type == 'paravirtualized' # TODO: Log a warning when the subtype is not found. 'OCI::Core::Models::VolumeAttachment' end |
.swagger_types ⇒ Object
Attribute type mapping.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/oci/core/models/volume_attachment.rb', line 113 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'attachment_type': :'String', 'availability_domain': :'String', 'compartment_id': :'String', 'device': :'String', 'display_name': :'String', 'id': :'String', 'instance_id': :'String', 'is_read_only': :'BOOLEAN', 'is_shareable': :'BOOLEAN', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'volume_id': :'String', 'is_pv_encryption_in_transit_enabled': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/oci/core/models/volume_attachment.rb', line 266 def ==(other) return true if equal?(other) self.class == other.class && == other. && availability_domain == other.availability_domain && compartment_id == other.compartment_id && device == other.device && display_name == other.display_name && id == other.id && instance_id == other.instance_id && is_read_only == other.is_read_only && is_shareable == other.is_shareable && lifecycle_state == other.lifecycle_state && time_created == other.time_created && volume_id == other.volume_id && is_pv_encryption_in_transit_enabled == other.is_pv_encryption_in_transit_enabled end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/oci/core/models/volume_attachment.rb', line 308 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
288 289 290 |
# File 'lib/oci/core/models/volume_attachment.rb', line 288 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
297 298 299 |
# File 'lib/oci/core/models/volume_attachment.rb', line 297 def hash [, availability_domain, compartment_id, device, display_name, id, instance_id, is_read_only, is_shareable, lifecycle_state, time_created, volume_id, is_pv_encryption_in_transit_enabled].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
341 342 343 344 345 346 347 348 349 350 |
# File 'lib/oci/core/models/volume_attachment.rb', line 341 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
335 336 337 |
# File 'lib/oci/core/models/volume_attachment.rb', line 335 def to_s to_hash.to_s end |