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



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
105
106
107
108
109
110
111
112
 
# File 'lib/oci/core/models/volume.rb', line 66

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[:'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

#display_name ⇒ String

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/volume.rb', line 31

def display_name
  @display_name
end

#id ⇒ String

The OCID of the volume.

Returns:

  • (String) 


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

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) 


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

def is_hydrated
  @is_hydrated
end

#lifecycle_state ⇒ String

The current state of a volume.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#size_in_gbs ⇒ Integer

The size of the volume in GBs.

Returns:

  • (Integer) 


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

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) 


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

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:



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

def source_details
  @source_details
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/core/models/volume.rb', line 126

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



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

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


143
144
145
 
# File 'lib/oci/core/models/volume.rb', line 143

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/oci/core/models/volume.rb', line 149

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



181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/core/models/volume.rb', line 181

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



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

def to_s
  to_hash.to_s
end