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

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

Overview

A detachable boot volume device that contains the image used to boot an Compute instance. For more information, see [Overview of Boot Volumes](docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

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

Options Hash (attributes):

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

  • :image_id (String) —

    The value to assign to the #image_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :size_in_gbs (Integer) —

    The value to assign to the #size_in_gbs property

  • :size_in_mbs (Integer) —

    The value to assign to the #size_in_mbs property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



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

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

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

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

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

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

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

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

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

  if attributes[:'size_in_mbs']
    self.size_in_mbs = attributes[:'size_in_mbs']
  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

end

Instance Attribute Details

#availability_domain ⇒ String

[Required] The Availability Domain of the boot volume.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/boot_volume.rb', line 28

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the boot volume.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#id ⇒ String

[Required] The boot volume’s Oracle ID (OCID).

Returns:

  • (String) 


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

def id
  @id
end

#image_id ⇒ String

The image OCID used to create the boot volume.

Returns:

  • (String) 


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

def image_id
  @image_id
end

#lifecycle_state ⇒ String

[Required] The current state of a boot volume.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/core/models/boot_volume.rb', line 50

def lifecycle_state
  @lifecycle_state
end

#size_in_gbs ⇒ Integer

The size of the boot volume in GBs.

Returns:

  • (Integer) 


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

def size_in_gbs
  @size_in_gbs
end

#size_in_mbs ⇒ Integer

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

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/core/models/boot_volume.rb', line 60

def size_in_mbs
  @size_in_mbs
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/core/models/boot_volume.rb', line 64

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



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/core/models/boot_volume.rb', line 182

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



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

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


198
199
200
 
# File 'lib/oci/core/models/boot_volume.rb', line 198

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/core/models/boot_volume.rb', line 204

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/core/models/boot_volume.rb', line 236

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



230
231
232
 
# File 'lib/oci/core/models/boot_volume.rb', line 230

def to_s
  to_hash.to_s
end