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

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

Overview

A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see [Overview of Cloud Volume Storage](docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.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_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']
SOURCE_TYPE_ENUM = 
[SOURCE_TYPE_MANUAL = 'MANUAL',
SOURCE_TYPE_SCHEDULED = 'SCHEDULED',
SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
TYPE_ENUM = 
[TYPE_FULL = 'FULL',
TYPE_INCREMENTAL = 'INCREMENTAL',
TYPE_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

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :expiration_time (DateTime) —

    The value to assign to the #expiration_time property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :id (String) —

    The value to assign to the #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

  • :source_type (String) —

    The value to assign to the #source_type property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_request_received (DateTime) —

    The value to assign to the #time_request_received property

  • :type (String) —

    The value to assign to the #type property

  • :unique_size_in_gbs (Integer) —

    The value to assign to the #unique_size_in_gbs property

  • :unique_size_in_mbs (Integer) —

    The value to assign to the #unique_size_in_mbs property

  • :volume_id (String) —

    The value to assign to the #volume_id property



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/core/models/volume_backup.rb', line 144

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

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

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

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

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

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

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

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

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

  if attributes[:'id']
    self.id = attributes[:'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[:'sourceType']
    self.source_type = attributes[:'sourceType']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/core/models/volume_backup.rb', line 36

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#expiration_time ⇒ DateTime

The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/core/models/volume_backup.rb', line 59

def expiration_time
  @expiration_time
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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the volume backup.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of a volume backup.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#size_in_gbs ⇒ Integer

The size of the volume, in GBs.

Returns:

  • (Integer) 


81
82
83
 
# File 'lib/oci/core/models/volume_backup.rb', line 81

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) 


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

def size_in_mbs
  @size_in_mbs
end

#source_type ⇒ String

Specifies whether the backup was created manually, or via scheduled backup policy.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/core/models/volume_backup.rb', line 91

def source_type
  @source_type
end

#time_created ⇒ DateTime

[Required] 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) 


97
98
99
 
# File 'lib/oci/core/models/volume_backup.rb', line 97

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) 


102
103
104
 
# File 'lib/oci/core/models/volume_backup.rb', line 102

def time_request_received
  @time_request_received
end

#type ⇒ String

[Required] The type of a volume backup.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/core/models/volume_backup.rb', line 106

def type
  @type
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) 


112
113
114
 
# File 'lib/oci/core/models/volume_backup.rb', line 112

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) 


119
120
121
 
# File 'lib/oci/core/models/volume_backup.rb', line 119

def unique_size_in_mbs
  @unique_size_in_mbs
end

#volume_id ⇒ String

The OCID of the volume.

Returns:

  • (String) 


123
124
125
 
# File 'lib/oci/core/models/volume_backup.rb', line 123

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/core/models/volume_backup.rb', line 332

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 &&
      expiration_time == other_object.expiration_time &&
      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 &&
      source_type == other_object.source_type &&
      time_created == other_object.time_created &&
      time_request_received == other_object.time_request_received &&
      type == other_object.type &&
      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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/core/models/volume_backup.rb', line 368

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


355
356
357
 
# File 'lib/oci/core/models/volume_backup.rb', line 355

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



361
362
363
 
# File 'lib/oci/core/models/volume_backup.rb', line 361

def hash
  [compartment_id, defined_tags, display_name, expiration_time, freeform_tags, id, lifecycle_state, size_in_gbs, size_in_mbs, source_type, time_created, time_request_received, type, 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



393
394
395
396
397
398
399
400
401
 
# File 'lib/oci/core/models/volume_backup.rb', line 393

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



387
388
389
 
# File 'lib/oci/core/models/volume_backup.rb', line 387

def to_s
  to_hash.to_s
end