Class: OracleBMC::Core::Models::AttachVolumeDetails

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

Direct Known Subclasses

AttachIScsiVolumeDetails

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AttachVolumeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 38

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[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'instanceId']
    self.instance_id = attributes[:'instanceId']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'volumeId']
    self.volume_id = attributes[:'volumeId']
  end
  
end

Instance Attribute Details

#display_nameString

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

Returns:

  • (String)


10
11
12
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 10

def display_name
  @display_name
end

#instance_idString

The OCID of the instance.

Returns:

  • (String)


14
15
16
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 14

def instance_id
  @instance_id
end

#typeString

The type of volume. The only supported value is "iscsi".

Returns:

  • (String)


18
19
20
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 18

def type
  @type
end

#volume_idString

The OCID of the volume.

Returns:

  • (String)


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

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.



27
28
29
30
31
32
33
34
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 27

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

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

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

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object)

    to be compared



65
66
67
68
69
70
71
72
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 65

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      display_name == other_object.display_name &&
      instance_id == other_object.instance_id &&
      type == other_object.type &&
      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



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

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


76
77
78
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 76

def eql?(other_object)
  self == other_object
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



82
83
84
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 82

def hash
  [display_name, instance_id, type, volume_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



114
115
116
117
118
119
120
121
122
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 114

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



108
109
110
# File 'lib/oraclebmc/core/models/attach_volume_details.rb', line 108

def to_s
  to_hash.to_s
end