CreateVolumeGroupBackupDetails¶

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

Bases: object

CreateVolumeGroupBackupDetails model.

Attributes

`TYPE_FULL`	A constant which can be used with the type property of a CreateVolumeGroupBackupDetails.
`TYPE_INCREMENTAL`	A constant which can be used with the type property of a CreateVolumeGroupBackupDetails.
`compartment_id`	Gets the compartment_id of this CreateVolumeGroupBackupDetails.
`defined_tags`	Gets the defined_tags of this CreateVolumeGroupBackupDetails.
`display_name`	Gets the display_name of this CreateVolumeGroupBackupDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVolumeGroupBackupDetails.
`is_indefinite_retention_enabled`	Gets the is_indefinite_retention_enabled of this CreateVolumeGroupBackupDetails.
`is_prevent_deletion_enabled`	Gets the is_prevent_deletion_enabled of this CreateVolumeGroupBackupDetails.
`is_retention_lock_enabled`	Gets the is_retention_lock_enabled of this CreateVolumeGroupBackupDetails.
`retention_period`	Gets the retention_period of this CreateVolumeGroupBackupDetails.
`type`	Gets the type of this CreateVolumeGroupBackupDetails.
`volume_group_id`	[Required] Gets the volume_group_id of this CreateVolumeGroupBackupDetails.

Methods

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

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

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

__init__(**kwargs)¶

Initializes a new CreateVolumeGroupBackupDetails 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 CreateVolumeGroupBackupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateVolumeGroupBackupDetails.
display_name (str) – The value to assign to the display_name property of this CreateVolumeGroupBackupDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateVolumeGroupBackupDetails.
type (str) – The value to assign to the type property of this CreateVolumeGroupBackupDetails. Allowed values for this property are: “FULL”, “INCREMENTAL”
volume_group_id (str) – The value to assign to the volume_group_id property of this CreateVolumeGroupBackupDetails.
retention_period (oci.core.models.RetentionDuration) – The value to assign to the retention_period property of this CreateVolumeGroupBackupDetails.
is_prevent_deletion_enabled (bool) – The value to assign to the is_prevent_deletion_enabled property of this CreateVolumeGroupBackupDetails.
is_retention_lock_enabled (bool) – The value to assign to the is_retention_lock_enabled property of this CreateVolumeGroupBackupDetails.
is_indefinite_retention_enabled (bool) – The value to assign to the is_indefinite_retention_enabled property of this CreateVolumeGroupBackupDetails.

compartment_id¶

Gets the compartment_id of this CreateVolumeGroupBackupDetails. The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

is_indefinite_retention_enabled¶

Gets the is_indefinite_retention_enabled of this CreateVolumeGroupBackupDetails. 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 CreateVolumeGroupBackupDetails.
Return type:	bool

is_prevent_deletion_enabled¶

Gets the is_prevent_deletion_enabled of this CreateVolumeGroupBackupDetails. 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 CreateVolumeGroupBackupDetails.
Return type:	bool

is_retention_lock_enabled¶

Gets the is_retention_lock_enabled of this CreateVolumeGroupBackupDetails. 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 CreateVolumeGroupBackupDetails.
Return type:	bool

retention_period¶

Gets the retention_period of this CreateVolumeGroupBackupDetails.

Returns:	The retention_period of this CreateVolumeGroupBackupDetails.
Return type:	oci.core.models.RetentionDuration

type¶

Gets the type of this CreateVolumeGroupBackupDetails. The type of backup to create. If omitted, defaults to incremental.

Allowed values for this property are: “FULL”, “INCREMENTAL”

Returns:	The type of this CreateVolumeGroupBackupDetails.
Return type:	str

volume_group_id¶

[Required] Gets the volume_group_id of this CreateVolumeGroupBackupDetails. The OCID of the volume group that needs to be backed up.

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