Class: OCI::Core::Models::VolumeAttachment

Inherits:
Object
  • Object
show all
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

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
ISCSI_LOGIN_STATE_ENUM = 
[
  ISCSI_LOGIN_STATE_UNKNOWN = 'UNKNOWN'.freeze,
  ISCSI_LOGIN_STATE_LOGGING_IN = 'LOGGING_IN'.freeze,
  ISCSI_LOGIN_STATE_LOGIN_SUCCEEDED = 'LOGIN_SUCCEEDED'.freeze,
  ISCSI_LOGIN_STATE_LOGIN_FAILED = 'LOGIN_FAILED'.freeze,
  ISCSI_LOGIN_STATE_LOGGING_OUT = 'LOGGING_OUT'.freeze,
  ISCSI_LOGIN_STATE_LOGOUT_SUCCEEDED = 'LOGOUT_SUCCEEDED'.freeze,
  ISCSI_LOGIN_STATE_LOGOUT_FAILED = 'LOGOUT_FAILED'.freeze,
  ISCSI_LOGIN_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeAttachment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :attachment_type (String) —

    The value to assign to the #attachment_type property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :device (String) —

    The value to assign to the #device property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :instance_id (String) —

    The value to assign to the #instance_id property

  • :is_read_only (BOOLEAN) —

    The value to assign to the #is_read_only property

  • :is_shareable (BOOLEAN) —

    The value to assign to the #is_shareable property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :volume_id (String) —

    The value to assign to the #volume_id property

  • :is_pv_encryption_in_transit_enabled (BOOLEAN) —

    The value to assign to the #is_pv_encryption_in_transit_enabled property

  • :is_multipath (BOOLEAN) —

    The value to assign to the #is_multipath property

  • :iscsi_login_state (String) —

    The value to assign to the #iscsi_login_state property

  • :is_volume_created_during_launch (BOOLEAN) —

    The value to assign to the #is_volume_created_during_launch property



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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/core/models/volume_attachment.rb', line 209

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

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

  self.attachment_type = 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?

  self.is_multipath = attributes[:'isMultipath'] unless attributes[:'isMultipath'].nil?

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

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

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

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

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

  self.is_volume_created_during_launch = attributes[:'isVolumeCreatedDuringLaunch'] unless attributes[:'isVolumeCreatedDuringLaunch'].nil?

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

  self.is_volume_created_during_launch = attributes[:'is_volume_created_during_launch'] unless attributes[:'is_volume_created_during_launch'].nil?
end

Instance Attribute Details

#attachment_type ⇒ String

[Required] The type of volume attachment.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/core/models/volume_attachment.rb', line 43

def attachment_type
  @attachment_type
end

#availability_domain ⇒ String

[Required] The availability domain of an instance.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/core/models/volume_attachment.rb', line 50

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#device ⇒ String

The device name.

Returns:

  • (String) 


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

def device
  @device
end

#display_name ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/core/models/volume_attachment.rb', line 64

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the volume attachment.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/core/models/volume_attachment.rb', line 68

def id
  @id
end

#instance_id ⇒ String

[Required] The OCID of the instance the volume is attached to.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/core/models/volume_attachment.rb', line 72

def instance_id
  @instance_id
end

#is_multipath ⇒ BOOLEAN

Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.

Returns:

  • (BOOLEAN) 


108
109
110
 
# File 'lib/oci/core/models/volume_attachment.rb', line 108

def is_multipath
  @is_multipath
end

#is_pv_encryption_in_transit_enabled ⇒ BOOLEAN

Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not.

Returns:

  • (BOOLEAN) 


104
105
106
 
# File 'lib/oci/core/models/volume_attachment.rb', line 104

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.

Returns:

  • (BOOLEAN) 


76
77
78
 
# File 'lib/oci/core/models/volume_attachment.rb', line 76

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.

Returns:

  • (BOOLEAN) 


84
85
86
 
# File 'lib/oci/core/models/volume_attachment.rb', line 84

def is_shareable
  @is_shareable
end

#is_volume_created_during_launch ⇒ BOOLEAN

Flag indicating if this volume was created for the customer as part of a simplified launch. Used to determine whether the volume requires deletion on instance termination.

Returns:

  • (BOOLEAN) 


120
121
122
 
# File 'lib/oci/core/models/volume_attachment.rb', line 120

def is_volume_created_during_launch
  @is_volume_created_during_launch
end

#iscsi_login_state ⇒ String

The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/core/models/volume_attachment.rb', line 114

def 
  @iscsi_login_state
end

#lifecycle_state ⇒ String

[Required] The current state of the volume attachment.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/core/models/volume_attachment.rb', line 88

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#volume_id ⇒ String

[Required] The OCID of the volume.

Returns:

  • (String) 


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

def volume_id
  @volume_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'is_multipath': :'isMultipath',
    'iscsi_login_state': :'iscsiLoginState',
    'is_volume_created_during_launch': :'isVolumeCreatedDuringLaunch'
    # 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.



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/core/models/volume_attachment.rb', line 175

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.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/core/models/volume_attachment.rb', line 147

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',
    'is_multipath': :'BOOLEAN',
    'iscsi_login_state': :'String',
    'is_volume_created_during_launch': :'BOOLEAN'
    # 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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/core/models/volume_attachment.rb', line 337

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

  self.class == other.class &&
    attachment_type == other.attachment_type &&
    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 &&
    is_multipath == other.is_multipath &&
     == other. &&
    is_volume_created_during_launch == other.is_volume_created_during_launch
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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/core/models/volume_attachment.rb', line 382

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


362
363
364
 
# File 'lib/oci/core/models/volume_attachment.rb', line 362

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



371
372
373
 
# File 'lib/oci/core/models/volume_attachment.rb', line 371

def hash
  [attachment_type, 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, is_multipath, , is_volume_created_during_launch].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



415
416
417
418
419
420
421
422
423
424
 
# File 'lib/oci/core/models/volume_attachment.rb', line 415

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

Returns:

  • (String) —

    String presentation of the object



409
410
411
 
# File 'lib/oci/core/models/volume_attachment.rb', line 409

def to_s
  to_hash.to_s
end