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](docs.cloud.oracle.com/Content/Block/Concepts/overview.htm).

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

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

  • :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



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

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.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.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/core/models/volume_attachment.rb', line 30

def attachment_type
  @attachment_type
end

#availability_domain ⇒ String

[Required] The availability domain of an instance.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/core/models/volume_attachment.rb', line 37

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/core/models/volume_attachment.rb', line 41

def compartment_id
  @compartment_id
end

#device ⇒ String

The device name.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/core/models/volume_attachment.rb', line 45

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`

Returns:

  • (String) 


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

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the volume attachment.

Returns:

  • (String) 


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

def id
  @id
end

#instance_id ⇒ String

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

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/core/models/volume_attachment.rb', line 61

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.

Returns:

  • (BOOLEAN) 


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

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) 


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

def is_read_only
  @is_read_only
end

#lifecycle_state ⇒ String

[Required] The current state of the volume attachment.

Returns:

  • (String) 


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

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) 


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

def time_created
  @time_created
end

#volume_id ⇒ String

[Required] The OCID of the volume.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/core/models/volume_attachment.rb', line 80

def volume_id
  @volume_id
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/core/models/volume_attachment.rb', line 87

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',
    '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.



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/core/models/volume_attachment.rb', line 131

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.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/core/models/volume_attachment.rb', line 107

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',
    '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.

Parameters:

  • other (Object) —

    the other object to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/core/models/volume_attachment.rb', line 252

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 &&
    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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/core/models/volume_attachment.rb', line 293

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


273
274
275
 
# File 'lib/oci/core/models/volume_attachment.rb', line 273

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



282
283
284
 
# File 'lib/oci/core/models/volume_attachment.rb', line 282

def hash
  [attachment_type, availability_domain, compartment_id, device, display_name, id, instance_id, is_read_only, 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

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/core/models/volume_attachment.rb', line 326

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



320
321
322
 
# File 'lib/oci/core/models/volume_attachment.rb', line 320

def to_s
  to_hash.to_s
end