VolumeBackup

class oci.core.models.VolumeBackup(**kwargs)

Bases: object

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.

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.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes:

LIFECYCLE_STATE_AVAILABLE

A constant which can be used with the lifecycle_state property of a VolumeBackup.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a VolumeBackup.

LIFECYCLE_STATE_FAULTY

A constant which can be used with the lifecycle_state property of a VolumeBackup.

LIFECYCLE_STATE_REQUEST_RECEIVED

A constant which can be used with the lifecycle_state property of a VolumeBackup.

LIFECYCLE_STATE_TERMINATED

A constant which can be used with the lifecycle_state property of a VolumeBackup.

LIFECYCLE_STATE_TERMINATING

A constant which can be used with the lifecycle_state property of a VolumeBackup.

SOURCE_TYPE_MANUAL

A constant which can be used with the source_type property of a VolumeBackup.

SOURCE_TYPE_SCHEDULED

A constant which can be used with the source_type property of a VolumeBackup.

TYPE_FULL

A constant which can be used with the type property of a VolumeBackup.

TYPE_INCREMENTAL

A constant which can be used with the type property of a VolumeBackup.

compartment_id

[Required] Gets the compartment_id of this VolumeBackup.

defined_tags

Gets the defined_tags of this VolumeBackup.

display_name

[Required] Gets the display_name of this VolumeBackup.

expiration_time

Gets the expiration_time of this VolumeBackup.

freeform_tags

Gets the freeform_tags of this VolumeBackup.

id

[Required] Gets the id of this VolumeBackup.

is_indefinite_retention_enabled

Gets the is_indefinite_retention_enabled of this VolumeBackup.

is_prevent_deletion_enabled

Gets the is_prevent_deletion_enabled of this VolumeBackup.

is_retention_lock_enabled

Gets the is_retention_lock_enabled of this VolumeBackup.

kms_key_id

Gets the kms_key_id of this VolumeBackup.

lifecycle_state

[Required] Gets the lifecycle_state of this VolumeBackup.

retention_period

Gets the retention_period of this VolumeBackup.

size_in_gbs

Gets the size_in_gbs of this VolumeBackup.

size_in_mbs

Gets the size_in_mbs of this VolumeBackup.

source_type

Gets the source_type of this VolumeBackup.

source_volume_backup_id

Gets the source_volume_backup_id of this VolumeBackup.

system_tags

Gets the system_tags of this VolumeBackup.

time_created

[Required] Gets the time_created of this VolumeBackup.

time_request_received

Gets the time_request_received of this VolumeBackup.

time_retention_expires_at

Gets the time_retention_expires_at of this VolumeBackup.

type

[Required] Gets the type of this VolumeBackup.

unique_size_in_gbs

Gets the unique_size_in_gbs of this VolumeBackup.

unique_size_in_mbs

Gets the unique_size_in_mbs of this VolumeBackup.

volume_group_backup_id

Gets the volume_group_backup_id of this VolumeBackup.

volume_id

Gets the volume_id of this VolumeBackup.

Methods:

__init__(**kwargs)

Initializes a new VolumeBackup object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a VolumeBackup. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a VolumeBackup. This constant has a value of “CREATING”

LIFECYCLE_STATE_FAULTY = 'FAULTY'

A constant which can be used with the lifecycle_state property of a VolumeBackup. This constant has a value of “FAULTY”

LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED'

A constant which can be used with the lifecycle_state property of a VolumeBackup. This constant has a value of “REQUEST_RECEIVED”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a VolumeBackup. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a VolumeBackup. This constant has a value of “TERMINATING”

SOURCE_TYPE_MANUAL = 'MANUAL'

A constant which can be used with the source_type property of a VolumeBackup. This constant has a value of “MANUAL”

SOURCE_TYPE_SCHEDULED = 'SCHEDULED'

A constant which can be used with the source_type property of a VolumeBackup. This constant has a value of “SCHEDULED”

TYPE_FULL = 'FULL'

A constant which can be used with the type property of a VolumeBackup. This constant has a value of “FULL”

TYPE_INCREMENTAL = 'INCREMENTAL'

A constant which can be used with the type property of a VolumeBackup. This constant has a value of “INCREMENTAL”

__init__(**kwargs)

Initializes a new VolumeBackup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • compartment_id (str) – The value to assign to the compartment_id property of this VolumeBackup.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VolumeBackup.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VolumeBackup.

  • display_name (str) – The value to assign to the display_name property of this VolumeBackup.

  • expiration_time (datetime) – The value to assign to the expiration_time property of this VolumeBackup.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VolumeBackup.

  • id (str) – The value to assign to the id property of this VolumeBackup.

  • kms_key_id (str) – The value to assign to the kms_key_id property of this VolumeBackup.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this VolumeBackup. Allowed values for this property are: “CREATING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, “REQUEST_RECEIVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • size_in_gbs (int) – The value to assign to the size_in_gbs property of this VolumeBackup.

  • size_in_mbs (int) – The value to assign to the size_in_mbs property of this VolumeBackup.

  • source_type (str) – The value to assign to the source_type property of this VolumeBackup. Allowed values for this property are: “MANUAL”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • source_volume_backup_id (str) – The value to assign to the source_volume_backup_id property of this VolumeBackup.

  • time_created (datetime) – The value to assign to the time_created property of this VolumeBackup.

  • time_request_received (datetime) – The value to assign to the time_request_received property of this VolumeBackup.

  • type (str) – The value to assign to the type property of this VolumeBackup. Allowed values for this property are: “FULL”, “INCREMENTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • unique_size_in_gbs (int) – The value to assign to the unique_size_in_gbs property of this VolumeBackup.

  • unique_size_in_mbs (int) – The value to assign to the unique_size_in_mbs property of this VolumeBackup.

  • volume_id (str) – The value to assign to the volume_id property of this VolumeBackup.

  • time_retention_expires_at (datetime) – The value to assign to the time_retention_expires_at property of this VolumeBackup.

  • retention_period (oci.core.models.RetentionDuration) – The value to assign to the retention_period property of this VolumeBackup.

  • is_prevent_deletion_enabled (bool) – The value to assign to the is_prevent_deletion_enabled property of this VolumeBackup.

  • is_retention_lock_enabled (bool) – The value to assign to the is_retention_lock_enabled property of this VolumeBackup.

  • is_indefinite_retention_enabled (bool) – The value to assign to the is_indefinite_retention_enabled property of this VolumeBackup.

  • volume_group_backup_id (str) – The value to assign to the volume_group_backup_id property of this VolumeBackup.

property compartment_id

[Required] Gets the compartment_id of this VolumeBackup. The OCID of the compartment that contains the volume backup.

Returns

The compartment_id of this VolumeBackup.

Return type

str

property defined_tags

Gets the defined_tags of this VolumeBackup. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this VolumeBackup.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this VolumeBackup. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this VolumeBackup.

Return type

str

property expiration_time

Gets the expiration_time of this VolumeBackup. 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

The expiration_time of this VolumeBackup.

Return type

datetime

property freeform_tags

Gets the freeform_tags of this VolumeBackup. 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.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this VolumeBackup.

Return type

dict(str, str)

property id

[Required] Gets the id of this VolumeBackup. The OCID of the volume backup.

Returns

The id of this VolumeBackup.

Return type

str

property is_indefinite_retention_enabled

Gets the is_indefinite_retention_enabled of this VolumeBackup. feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.

Returns

The is_indefinite_retention_enabled of this VolumeBackup.

Return type

bool

property is_prevent_deletion_enabled

Gets the is_prevent_deletion_enabled of this VolumeBackup. Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.

Returns

The is_prevent_deletion_enabled of this VolumeBackup.

Return type

bool

property is_retention_lock_enabled

Gets the is_retention_lock_enabled of this VolumeBackup. feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.

Returns

The is_retention_lock_enabled of this VolumeBackup.

Return type

bool

property kms_key_id

Gets the kms_key_id of this VolumeBackup. The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

Returns

The kms_key_id of this VolumeBackup.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this VolumeBackup. The current state of a volume backup.

Allowed values for this property are: “CREATING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, “REQUEST_RECEIVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this VolumeBackup.

Return type

str

property retention_period

Gets the retention_period of this VolumeBackup.

Returns

The retention_period of this VolumeBackup.

Return type

oci.core.models.RetentionDuration

property size_in_gbs

Gets the size_in_gbs of this VolumeBackup. The size of the volume, in GBs.

Returns

The size_in_gbs of this VolumeBackup.

Return type

int

property size_in_mbs

Gets the size_in_mbs of this VolumeBackup. The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.

Returns

The size_in_mbs of this VolumeBackup.

Return type

int

property source_type

Gets the source_type of this VolumeBackup. Specifies whether the backup was created manually, or via scheduled backup policy.

Allowed values for this property are: “MANUAL”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The source_type of this VolumeBackup.

Return type

str

property source_volume_backup_id

Gets the source_volume_backup_id of this VolumeBackup. The OCID of the source volume backup.

Returns

The source_volume_backup_id of this VolumeBackup.

Return type

str

property system_tags

Gets the system_tags of this VolumeBackup. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The system_tags of this VolumeBackup.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this VolumeBackup. 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

The time_created of this VolumeBackup.

Return type

datetime

property time_request_received

Gets the time_request_received of this VolumeBackup. The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.

Returns

The time_request_received of this VolumeBackup.

Return type

datetime

property time_retention_expires_at

Gets the time_retention_expires_at of this VolumeBackup. The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.

Returns

The time_retention_expires_at of this VolumeBackup.

Return type

datetime

property type

[Required] Gets the type of this VolumeBackup. The type of a volume backup.

Allowed values for this property are: “FULL”, “INCREMENTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this VolumeBackup.

Return type

str

property unique_size_in_gbs

Gets the unique_size_in_gbs of this VolumeBackup. 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

The unique_size_in_gbs of this VolumeBackup.

Return type

int

property unique_size_in_mbs

Gets the unique_size_in_mbs of this VolumeBackup. 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

The unique_size_in_mbs of this VolumeBackup.

Return type

int

property volume_group_backup_id

Gets the volume_group_backup_id of this VolumeBackup. The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group.

Returns

The volume_group_backup_id of this VolumeBackup.

Return type

str

property volume_id

Gets the volume_id of this VolumeBackup. The OCID of the volume.

Returns

The volume_id of this VolumeBackup.

Return type

str