Class: OCI::Core::Models::VolumeBackup

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_FAULTY = 'FAULTY',
LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeBackup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes[:'timeRequestReceived']
    self.time_request_received = attributes[:'timeRequestReceived']
  end

  if attributes[:'uniqueSizeInGBs']
    self.unique_size_in_gbs = attributes[:'uniqueSizeInGBs']
  end

  if attributes[:'uniqueSizeInMbs']
    self.unique_size_in_mbs = attributes[:'uniqueSizeInMbs']
  end

  if attributes[:'volumeId']
    self.volume_id = attributes[:'volumeId']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment that contains the volume backup.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/core/models/volume_backup.rb', line 18

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


26
27
28
 
# File 'lib/oci/core/models/volume_backup.rb', line 26

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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


41
42
43
 
# File 'lib/oci/core/models/volume_backup.rb', line 41

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the volume backup.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/core/models/volume_backup.rb', line 45

def id
  @id
end

#lifecycle_state ⇒ String

The current state of a volume backup.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/core/models/volume_backup.rb', line 49

def lifecycle_state
  @lifecycle_state
end

#size_in_gbs ⇒ Integer

The size of the volume, in GBs.

Returns:

  • (Integer) 


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

def size_in_gbs
  @size_in_gbs
end

#size_in_mbs ⇒ Integer

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/volume_backup.rb', line 60

def size_in_mbs
  @size_in_mbs
end

#time_created ⇒ DateTime

The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/core/models/volume_backup.rb', line 66

def time_created
  @time_created
end

#time_request_received ⇒ DateTime

The date and time the request to create the volume backup was received. Format defined by RFC3339.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/core/models/volume_backup.rb', line 71

def time_request_received
  @time_request_received
end

#unique_size_in_gbs ⇒ Integer

The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/core/models/volume_backup.rb', line 77

def unique_size_in_gbs
  @unique_size_in_gbs
end

#unique_size_in_mbs ⇒ Integer

The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.

Returns:

  • (Integer) 


84
85
86
 
# File 'lib/oci/core/models/volume_backup.rb', line 84

def unique_size_in_mbs
  @unique_size_in_mbs
end

#volume_id ⇒ String

The OCID of the volume.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/core/models/volume_backup.rb', line 88

def volume_id
  @volume_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/core/models/volume_backup.rb', line 165

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      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 &&
      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 &&
      time_request_received == other_object.time_request_received &&
      unique_size_in_gbs == other_object.unique_size_in_gbs &&
      unique_size_in_mbs == other_object.unique_size_in_mbs &&
      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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/core/models/volume_backup.rb', line 198

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


185
186
187
 
# File 'lib/oci/core/models/volume_backup.rb', line 185

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/core/models/volume_backup.rb', line 191

def hash
  [compartment_id, defined_tags, display_name, freeform_tags, id, lifecycle_state, size_in_gbs, size_in_mbs, time_created, time_request_received, unique_size_in_gbs, unique_size_in_mbs, volume_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/core/models/volume_backup.rb', line 223

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



217
218
219
 
# File 'lib/oci/core/models/volume_backup.rb', line 217

def to_s
  to_hash.to_s
end