Class: OCI::Core::Models::BootVolume

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/boot_volume.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_RESTORING = 'RESTORING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_FAULTY = 'FAULTY',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BootVolume

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
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
# File 'lib/oci/core/models/boot_volume.rb', line 62

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[:'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[:'imageId']
    self.image_id = attributes[:'imageId']
  end

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

  if attributes[:'sizeInGBs']
    self.size_in_gbs = attributes[:'sizeInGBs']
  end

  if attributes[:'sizeInMBs']
    self.size_in_mbs = attributes[:'sizeInMBs']
  end

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

end

Instance Attribute Details

#availability_domainString

The Availability Domain of the boot volume.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String)


21
22
23
# File 'lib/oci/core/models/boot_volume.rb', line 21

def availability_domain
  @availability_domain
end

#compartment_idString

The OCID of the compartment that contains the boot volume.

Returns:

  • (String)


25
26
27
# File 'lib/oci/core/models/boot_volume.rb', line 25

def compartment_id
  @compartment_id
end

#display_nameString

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

Returns:

  • (String)


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

def display_name
  @display_name
end

#idString

The boot volume’s Oracle ID (OCID).

Returns:

  • (String)


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

def id
  @id
end

#image_idString

The image OCID used to create the boot volume.

Returns:

  • (String)


39
40
41
# File 'lib/oci/core/models/boot_volume.rb', line 39

def image_id
  @image_id
end

#lifecycle_stateString

The current state of a boot volume.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#size_in_gbsInteger

The size of the boot volume in GBs.

Returns:

  • (Integer)


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

def size_in_gbs
  @size_in_gbs
end

#size_in_mbsInteger

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.

Returns:

  • (Integer)


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

def size_in_mbs
  @size_in_mbs
end

#time_createdDateTime

The date and time the boot volume was created. Format defined by RFC3339.

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object)

    to be compared



118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/oci/core/models/boot_volume.rb', line 118

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/core/models/boot_volume.rb', line 147

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


134
135
136
# File 'lib/oci/core/models/boot_volume.rb', line 134

def eql?(other_object)
  self == other_object
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



140
141
142
# File 'lib/oci/core/models/boot_volume.rb', line 140

def hash
  [availability_domain, compartment_id, display_name, id, image_id, lifecycle_state, size_in_gbs, size_in_mbs, time_created].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
# File 'lib/oci/core/models/boot_volume.rb', line 172

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



166
167
168
# File 'lib/oci/core/models/boot_volume.rb', line 166

def to_s
  to_hash.to_s
end