Class: OracleBMC::Core::Models::VolumeAttachment

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/volume_attachment.rb

Direct Known Subclasses

IScsiVolumeAttachment

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_ATTACHING = 'ATTACHING',
LIFECYCLE_STATE_ATTACHED = 'ATTACHED',
LIFECYCLE_STATE_DETACHING = 'DETACHING',
LIFECYCLE_STATE_DETACHED = 'DETACHED']

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 72

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
  
  if attributes[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end
  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'instanceId']
    self.instance_id = attributes[:'instanceId']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
  if attributes[:'volumeId']
    self.volume_id = attributes[:'volumeId']
  end
  
end

Instance Attribute Details

#attachment_type ⇒ String

The type of volume attachment.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 15

def attachment_type
  @attachment_type
end

#availability_domain ⇒ String

The Availability Domain of an instance.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


22
23
24
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 22

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 26

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it cannot be changed.

Example: ‘My volume attachment`

Returns:

  • (String) 


33
34
35
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 33

def display_name
  @display_name
end

#id ⇒ String

The OCID of the volume attachment.

Returns:

  • (String) 


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

def id
  @id
end

#instance_id ⇒ String

The OCID of the instance the volume is attached to.

Returns:

  • (String) 


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

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

The current state of the volume attachment.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the volume was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 52

def time_created
  @time_created
end

#volume_id ⇒ String

The OCID of the volume.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 56

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.



61
62
63
64
65
66
67
68
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 61

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

  return 'OracleBMC::Core::Models::IScsiVolumeAttachment' if type == 'iscsi'

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

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



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

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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 157

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


144
145
146
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 144

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 150

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



182
183
184
185
186
187
188
189
190
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 182

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



176
177
178
 
# File 'lib/oraclebmc/core/models/volume_attachment.rb', line 176

def to_s
  to_hash.to_s
end