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.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm).

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',
LIFECYCLE_STATE_ATTACHED = 'ATTACHED',
LIFECYCLE_STATE_DETACHING = 'DETACHING',
LIFECYCLE_STATE_DETACHED = 'DETACHED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

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

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
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
 
# File 'lib/oci/core/models/volume_attachment.rb', line 97

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}

  if attributes[:'attachmentType']
    self.attachment_type = attributes[:'attachmentType']
  end

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

  if attributes[:'attachment_type']
    self.attachment_type = attributes[:'attachment_type']
  end

  if attributes[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end

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

  if attributes[:'availability_domain']
    self.availability_domain = attributes[:'availability_domain']
  end

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

  if attributes[:'compartment_id']
    self.compartment_id = attributes[:'compartment_id']
  end

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

  if attributes[:'display_name']
    self.display_name = attributes[:'display_name']
  end

  if attributes[:'id']
    self.id = attributes[:'id']
  end

  if attributes[:'instanceId']
    self.instance_id = attributes[:'instanceId']
  end

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

  if attributes[:'instance_id']
    self.instance_id = attributes[:'instance_id']
  end

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

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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

  if attributes[:'lifecycle_state']
    self.lifecycle_state = attributes[:'lifecycle_state']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

  if attributes[:'time_created']
    self.time_created = attributes[:'time_created']
  end

  if attributes[:'volumeId']
    self.volume_id = attributes[:'volumeId']
  end

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

  if attributes[:'volume_id']
    self.volume_id = attributes[:'volume_id']
  end

end

Instance Attribute Details

#attachment_type ⇒ String

[Required] The type of volume attachment.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/core/models/volume_attachment.rb', line 24

def attachment_type
  @attachment_type
end

#availability_domain ⇒ String

[Required] The Availability Domain of an instance.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


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

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/core/models/volume_attachment.rb', line 35

def compartment_id
  @compartment_id
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) 


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

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the volume attachment.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/volume_attachment.rb', line 47

def id
  @id
end

#instance_id ⇒ String

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

Returns:

  • (String) 


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

def instance_id
  @instance_id
end

#is_read_only ⇒ BOOLEAN

Whether the attachment was created in read-only mode.

Returns:

  • (BOOLEAN) 


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

def is_read_only
  @is_read_only
end

#lifecycle_state ⇒ String

[Required] The current state of the volume attachment.

Returns:

  • (String) 


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

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) 


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

def time_created
  @time_created
end

#volume_id ⇒ String

[Required] The OCID of the volume.

Returns:

  • (String) 


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

def volume_id
  @volume_id
end

Class Method Details

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



75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/core/models/volume_attachment.rb', line 75

def self.get_subtype(object_hash)
  type = object_hash[:'attachmentType']

  return 'OCI::Core::Models::IScsiVolumeAttachment' if type == 'iscsi'
  return 'OCI::Core::Models::ParavirtualizedVolumeAttachment' if type == 'paravirtualized'

  # TODO: Log a warning when the subtype is not found.
  return 'OCI::Core::Models::VolumeAttachment'
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/core/models/volume_attachment.rb', line 211

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      attachment_type == other_object.attachment_type &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      instance_id == other_object.instance_id &&
      is_read_only == other_object.is_read_only &&
      lifecycle_state == other_object.lifecycle_state &&
      time_created == other_object.time_created &&
      volume_id == other_object.volume_id
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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/core/models/volume_attachment.rb', line 241

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


228
229
230
 
# File 'lib/oci/core/models/volume_attachment.rb', line 228

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/oci/core/models/volume_attachment.rb', line 234

def hash
  [attachment_type, availability_domain, compartment_id, display_name, id, instance_id, is_read_only, lifecycle_state, time_created, volume_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/core/models/volume_attachment.rb', line 266

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



260
261
262
 
# File 'lib/oci/core/models/volume_attachment.rb', line 260

def to_s
  to_hash.to_s
end