Class: OCI::Core::Models::Volume

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/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 = {}) ⇒ Volume

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

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

  if attributes[:'isHydrated']
    self.is_hydrated = attributes[:'isHydrated']
  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[:'sourceDetails']
    self.source_details = attributes[:'sourceDetails']
  end

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

end

Instance Attribute Details

#availability_domain ⇒ String

The Availability Domain of the volume.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


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

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment that contains the volume.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


33
34
35
 
# File 'lib/oci/core/models/volume.rb', line 33

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


48
49
50
 
# File 'lib/oci/core/models/volume.rb', line 48

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the volume.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/core/models/volume.rb', line 52

def id
  @id
end

#is_hydrated ⇒ BOOLEAN

Specifies whether the cloned volume’s data has finished copying from the source volume or backup.

Returns:

  • (BOOLEAN) 


56
57
58
 
# File 'lib/oci/core/models/volume.rb', line 56

def is_hydrated
  @is_hydrated
end

#lifecycle_state ⇒ String

The current state of a volume.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#size_in_gbs ⇒ Integer

The size of the volume in GBs.

Returns:

  • (Integer) 


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

def size_in_gbs
  @size_in_gbs
end

#size_in_mbs ⇒ Integer

The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.

Returns:

  • (Integer) 


68
69
70
 
# File 'lib/oci/core/models/volume.rb', line 68

def size_in_mbs
  @size_in_mbs
end

#source_details ⇒ OCI::Core::Models::VolumeSourceDetails

The volume source, either an existing volume in the same Availability Domain or a volume backup. If null, an empty volume is created.

Returns:



74
75
76
 
# File 'lib/oci/core/models/volume.rb', line 74

def source_details
  @source_details
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/core/models/volume.rb', line 78

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/core/models/volume.rb', line 151

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 &&
      defined_tags == other_object.defined_tags &&
      display_name == other_object.display_name &&
      freeform_tags == other_object.freeform_tags &&
      id == other_object.id &&
      is_hydrated == other_object.is_hydrated &&
      lifecycle_state == other_object.lifecycle_state &&
      size_in_gbs == other_object.size_in_gbs &&
      size_in_mbs == other_object.size_in_mbs &&
      source_details == other_object.source_details &&
      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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/core/models/volume.rb', line 183

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


170
171
172
 
# File 'lib/oci/core/models/volume.rb', line 170

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/oci/core/models/volume.rb', line 176

def hash
  [availability_domain, compartment_id, defined_tags, display_name, freeform_tags, id, is_hydrated, lifecycle_state, size_in_gbs, size_in_mbs, source_details, 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



208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/core/models/volume.rb', line 208

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



202
203
204
 
# File 'lib/oci/core/models/volume.rb', line 202

def to_s
  to_hash.to_s
end