OciCacheBackupSummary¶

class oci.redis.models.OciCacheBackupSummary(**kwargs)¶

Bases: object

Summary of the OCI Cache Backup.

Attributes

`BACKUP_TYPE_AUTOMATED`	A constant which can be used with the backup_type property of a OciCacheBackupSummary.
`BACKUP_TYPE_MANUAL`	A constant which can be used with the backup_type property of a OciCacheBackupSummary.
`backup_size_in_gbs`	Gets the backup_size_in_gbs of this OciCacheBackupSummary.
`backup_source`	Gets the backup_source of this OciCacheBackupSummary.
`backup_type`	Gets the backup_type of this OciCacheBackupSummary.
`cluster_mode`	[Required] Gets the cluster_mode of this OciCacheBackupSummary.
`compartment_id`	[Required] Gets the compartment_id of this OciCacheBackupSummary.
`defined_tags`	[Required] Gets the defined_tags of this OciCacheBackupSummary.
`display_name`	[Required] Gets the display_name of this OciCacheBackupSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this OciCacheBackupSummary.
`id`	[Required] Gets the id of this OciCacheBackupSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OciCacheBackupSummary.
`retention_period_in_days`	Gets the retention_period_in_days of this OciCacheBackupSummary.
`source_cluster_id`	[Required] Gets the source_cluster_id of this OciCacheBackupSummary.
`system_tags`	Gets the system_tags of this OciCacheBackupSummary.
`time_created`	[Required] Gets the time_created of this OciCacheBackupSummary.
`time_updated`	Gets the time_updated of this OciCacheBackupSummary.

Methods

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

BACKUP_TYPE_AUTOMATED = 'AUTOMATED'¶: A constant which can be used with the backup_type property of a OciCacheBackupSummary. This constant has a value of “AUTOMATED”

BACKUP_TYPE_MANUAL = 'MANUAL'¶: A constant which can be used with the backup_type property of a OciCacheBackupSummary. This constant has a value of “MANUAL”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this OciCacheBackupSummary.
display_name (str) – The value to assign to the display_name property of this OciCacheBackupSummary.
compartment_id (str) – The value to assign to the compartment_id property of this OciCacheBackupSummary.
source_cluster_id (str) – The value to assign to the source_cluster_id property of this OciCacheBackupSummary.
time_created (datetime) – The value to assign to the time_created property of this OciCacheBackupSummary.
time_updated (datetime) – The value to assign to the time_updated property of this OciCacheBackupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OciCacheBackupSummary.
cluster_mode (str) – The value to assign to the cluster_mode property of this OciCacheBackupSummary.
backup_source (str) – The value to assign to the backup_source property of this OciCacheBackupSummary.
retention_period_in_days (int) – The value to assign to the retention_period_in_days property of this OciCacheBackupSummary.
backup_size_in_gbs (float) – The value to assign to the backup_size_in_gbs property of this OciCacheBackupSummary.
backup_type (str) – The value to assign to the backup_type property of this OciCacheBackupSummary. Allowed values for this property are: “MANUAL”, “AUTOMATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OciCacheBackupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OciCacheBackupSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OciCacheBackupSummary.

backup_size_in_gbs¶

Gets the backup_size_in_gbs of this OciCacheBackupSummary. Backup size in GB.

Returns:	The backup_size_in_gbs of this OciCacheBackupSummary.
Return type:	float

backup_source¶

Gets the backup_source of this OciCacheBackupSummary. Specifies whether the backup was created from a replica or primary node

Returns:	The backup_source of this OciCacheBackupSummary.
Return type:	str

backup_type¶

Gets the backup_type of this OciCacheBackupSummary. Backup Type.

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

Returns:	The backup_type of this OciCacheBackupSummary.
Return type:	str

cluster_mode¶

[Required] Gets the cluster_mode of this OciCacheBackupSummary. Specifies whether the cluster is sharded or non-sharded.

Returns:	The cluster_mode of this OciCacheBackupSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this OciCacheBackupSummary. Compartment identifier

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

defined_tags¶

[Required] Gets the defined_tags of this OciCacheBackupSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this OciCacheBackupSummary.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this OciCacheBackupSummary. Backup identifier, can be renamed

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

freeform_tags¶

[Required] Gets the freeform_tags of this OciCacheBackupSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this OciCacheBackupSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this OciCacheBackupSummary. Unique identifier that is immutable on creation

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OciCacheBackupSummary. The current state of the backup.

Returns:	The lifecycle_state of this OciCacheBackupSummary.
Return type:	str

retention_period_in_days¶

Gets the retention_period_in_days of this OciCacheBackupSummary. Backup retention period in days.

Returns:	The retention_period_in_days of this OciCacheBackupSummary.
Return type:	int

source_cluster_id¶

[Required] Gets the source_cluster_id of this OciCacheBackupSummary. The source OCI Cache Cluster OCID.

Returns:	The source_cluster_id of this OciCacheBackupSummary.
Return type:	str

system_tags¶

Gets the system_tags of this OciCacheBackupSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this OciCacheBackupSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this OciCacheBackupSummary. The date and time the backup was created. An RFC3339 formatted datetime string.

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

time_updated¶

Gets the time_updated of this OciCacheBackupSummary. The date and time the backup was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this OciCacheBackupSummary.
Return type:	datetime