VolumeGroupBackup¶

class oci.core.models.VolumeGroupBackup(**kwargs)¶

Bases: object

A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see Volume Groups.

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 VolumeGroupBackup.
`LIFECYCLE_STATE_COMMITTED`	A constant which can be used with the lifecycle_state property of a VolumeGroupBackup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a VolumeGroupBackup.
`LIFECYCLE_STATE_FAULTY`	A constant which can be used with the lifecycle_state property of a VolumeGroupBackup.
`LIFECYCLE_STATE_REQUEST_RECEIVED`	A constant which can be used with the lifecycle_state property of a VolumeGroupBackup.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a VolumeGroupBackup.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a VolumeGroupBackup.
`SOURCE_TYPE_MANUAL`	A constant which can be used with the source_type property of a VolumeGroupBackup.
`SOURCE_TYPE_SCHEDULED`	A constant which can be used with the source_type property of a VolumeGroupBackup.
`TYPE_FULL`	A constant which can be used with the type property of a VolumeGroupBackup.
`TYPE_INCREMENTAL`	A constant which can be used with the type property of a VolumeGroupBackup.
`compartment_id`	[Required] Gets the compartment_id of this VolumeGroupBackup.
`defined_tags`	Gets the defined_tags of this VolumeGroupBackup.
`display_name`	[Required] Gets the display_name of this VolumeGroupBackup.
`expiration_time`	Gets the expiration_time of this VolumeGroupBackup.
`freeform_tags`	Gets the freeform_tags of this VolumeGroupBackup.
`id`	[Required] Gets the id of this VolumeGroupBackup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VolumeGroupBackup.
`size_in_gbs`	Gets the size_in_gbs of this VolumeGroupBackup.
`size_in_mbs`	Gets the size_in_mbs of this VolumeGroupBackup.
`source_type`	Gets the source_type of this VolumeGroupBackup.
`source_volume_group_backup_id`	Gets the source_volume_group_backup_id of this VolumeGroupBackup.
`time_created`	[Required] Gets the time_created of this VolumeGroupBackup.
`time_request_received`	Gets the time_request_received of this VolumeGroupBackup.
`type`	[Required] Gets the type of this VolumeGroupBackup.
`unique_size_in_gbs`	Gets the unique_size_in_gbs of this VolumeGroupBackup.
`unique_size_in_mbs`	Gets the unique_size_in_mbs of this VolumeGroupBackup.
`volume_backup_ids`	[Required] Gets the volume_backup_ids of this VolumeGroupBackup.
`volume_group_id`	Gets the volume_group_id of this VolumeGroupBackup.

Methods

__init__(**kwargs) Initializes a new VolumeGroupBackup object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a VolumeGroupBackup. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_COMMITTED = 'COMMITTED'¶: A constant which can be used with the lifecycle_state property of a VolumeGroupBackup. This constant has a value of “COMMITTED”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a VolumeGroupBackup. This constant has a value of “CREATING”

LIFECYCLE_STATE_FAULTY = 'FAULTY'¶: A constant which can be used with the lifecycle_state property of a VolumeGroupBackup. 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 VolumeGroupBackup. 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 VolumeGroupBackup. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a VolumeGroupBackup. This constant has a value of “TERMINATING”

SOURCE_TYPE_MANUAL = 'MANUAL'¶: A constant which can be used with the source_type property of a VolumeGroupBackup. This constant has a value of “MANUAL”

SOURCE_TYPE_SCHEDULED = 'SCHEDULED'¶: A constant which can be used with the source_type property of a VolumeGroupBackup. This constant has a value of “SCHEDULED”

TYPE_FULL = 'FULL'¶: A constant which can be used with the type property of a VolumeGroupBackup. This constant has a value of “FULL”

TYPE_INCREMENTAL = 'INCREMENTAL'¶: A constant which can be used with the type property of a VolumeGroupBackup. This constant has a value of “INCREMENTAL”

__init__(**kwargs)¶

Initializes a new VolumeGroupBackup 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 VolumeGroupBackup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VolumeGroupBackup.
display_name (str) – The value to assign to the display_name property of this VolumeGroupBackup.
expiration_time (datetime) – The value to assign to the expiration_time property of this VolumeGroupBackup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VolumeGroupBackup.
id (str) – The value to assign to the id property of this VolumeGroupBackup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VolumeGroupBackup. Allowed values for this property are: “CREATING”, “COMMITTED”, “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_mbs (int) – The value to assign to the size_in_mbs property of this VolumeGroupBackup.
size_in_gbs (int) – The value to assign to the size_in_gbs property of this VolumeGroupBackup.
source_type (str) – The value to assign to the source_type property of this VolumeGroupBackup. 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’.
time_created (datetime) – The value to assign to the time_created property of this VolumeGroupBackup.
time_request_received (datetime) – The value to assign to the time_request_received property of this VolumeGroupBackup.
type (str) – The value to assign to the type property of this VolumeGroupBackup. 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_mbs (int) – The value to assign to the unique_size_in_mbs property of this VolumeGroupBackup.
unique_size_in_gbs (int) – The value to assign to the unique_size_in_gbs property of this VolumeGroupBackup.
volume_backup_ids (list[str]) – The value to assign to the volume_backup_ids property of this VolumeGroupBackup.
volume_group_id (str) – The value to assign to the volume_group_id property of this VolumeGroupBackup.
source_volume_group_backup_id (str) – The value to assign to the source_volume_group_backup_id property of this VolumeGroupBackup.

compartment_id¶

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

Returns:	The compartment_id of this VolumeGroupBackup.
Return type:	str

defined_tags¶

Gets the defined_tags of this VolumeGroupBackup. 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 VolumeGroupBackup.
Return type:	dict(str, dict(str, object))

display_name¶

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

Returns:	The display_name of this VolumeGroupBackup.
Return type:	str

expiration_time¶

Gets the expiration_time of this VolumeGroupBackup. The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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 VolumeGroupBackup.
Return type:	datetime

freeform_tags¶

Gets the freeform_tags of this VolumeGroupBackup. 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 VolumeGroupBackup.
Return type:	dict(str, str)

id¶

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

Returns:	The id of this VolumeGroupBackup.
Return type:	str

lifecycle_state¶

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

Allowed values for this property are: “CREATING”, “COMMITTED”, “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 VolumeGroupBackup.
Return type:	str

size_in_gbs¶

Gets the size_in_gbs of this VolumeGroupBackup. The aggregate size of the volume group backup, in GBs.

Returns:	The size_in_gbs of this VolumeGroupBackup.
Return type:	int

size_in_mbs¶

Gets the size_in_mbs of this VolumeGroupBackup. The aggregate size of the volume group backup, in MBs.

Returns:	The size_in_mbs of this VolumeGroupBackup.
Return type:	int

source_type¶

Gets the source_type of this VolumeGroupBackup. Specifies whether the volume group 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 VolumeGroupBackup.
Return type:	str

source_volume_group_backup_id¶

Gets the source_volume_group_backup_id of this VolumeGroupBackup. The OCID of the source volume group backup.

Returns:	The source_volume_group_backup_id of this VolumeGroupBackup.
Return type:	str

time_created¶

[Required] Gets the time_created of this VolumeGroupBackup. The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.

Returns:	The time_created of this VolumeGroupBackup.
Return type:	datetime

time_request_received¶

Gets the time_request_received of this VolumeGroupBackup. The date and time the request to create the volume group backup was received. Format defined by RFC3339.

Returns:	The time_request_received of this VolumeGroupBackup.
Return type:	datetime

type¶

[Required] Gets the type of this VolumeGroupBackup. The type of 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 VolumeGroupBackup.
Return type:	str

unique_size_in_gbs¶

Gets the unique_size_in_gbs of this VolumeGroupBackup. The aggregate size used by the volume group backup, in GBs.

It is typically smaller than sizeInGBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.

Returns:	The unique_size_in_gbs of this VolumeGroupBackup.
Return type:	int

unique_size_in_mbs¶

Gets the unique_size_in_mbs of this VolumeGroupBackup. The aggregate size used by the volume group backup, in MBs.

It is typically smaller than sizeInMBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.

Returns:	The unique_size_in_mbs of this VolumeGroupBackup.
Return type:	int

volume_backup_ids¶

[Required] Gets the volume_backup_ids of this VolumeGroupBackup. OCIDs for the volume backups in this volume group backup.

Returns:	The volume_backup_ids of this VolumeGroupBackup.
Return type:	list[str]

volume_group_id¶

Gets the volume_group_id of this VolumeGroupBackup. The OCID of the source volume group.

Returns:	The volume_group_id of this VolumeGroupBackup.
Return type:	str