OciCacheBackup¶

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

Bases: object

OCI Cache cluster backup information

Attributes

`BACKUP_SOURCE_PRIMARY`	A constant which can be used with the backup_source property of a OciCacheBackup.
`BACKUP_SOURCE_REPLICA`	A constant which can be used with the backup_source property of a OciCacheBackup.
`BACKUP_TYPE_AUTOMATED`	A constant which can be used with the backup_type property of a OciCacheBackup.
`BACKUP_TYPE_MANUAL`	A constant which can be used with the backup_type property of a OciCacheBackup.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OciCacheBackup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OciCacheBackup.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OciCacheBackup.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OciCacheBackup.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OciCacheBackup.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OciCacheBackup.
`backup_size_in_gbs`	[Required] Gets the backup_size_in_gbs of this OciCacheBackup.
`backup_source`	Gets the backup_source of this OciCacheBackup.
`backup_type`	Gets the backup_type of this OciCacheBackup.
`cluster_memory_in_gbs`	Gets the cluster_memory_in_gbs of this OciCacheBackup.
`cluster_mode`	[Required] Gets the cluster_mode of this OciCacheBackup.
`compartment_id`	[Required] Gets the compartment_id of this OciCacheBackup.
`defined_tags`	Gets the defined_tags of this OciCacheBackup.
`description`	Gets the description of this OciCacheBackup.
`display_name`	[Required] Gets the display_name of this OciCacheBackup.
`freeform_tags`	Gets the freeform_tags of this OciCacheBackup.
`id`	[Required] Gets the id of this OciCacheBackup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OciCacheBackup.
`retention_period_in_days`	Gets the retention_period_in_days of this OciCacheBackup.
`shard_count`	Gets the shard_count of this OciCacheBackup.
`software_version`	[Required] Gets the software_version of this OciCacheBackup.
`source_cluster_id`	[Required] Gets the source_cluster_id of this OciCacheBackup.
`system_tags`	Gets the system_tags of this OciCacheBackup.
`time_created`	Gets the time_created of this OciCacheBackup.
`time_updated`	Gets the time_updated of this OciCacheBackup.

Methods

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

BACKUP_SOURCE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the backup_source property of a OciCacheBackup. This constant has a value of “PRIMARY”

BACKUP_SOURCE_REPLICA = 'REPLICA'¶: A constant which can be used with the backup_source property of a OciCacheBackup. This constant has a value of “REPLICA”

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

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OciCacheBackup. This constant has a value of “ACTIVE”

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

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OciCacheBackup. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OciCacheBackup. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OciCacheBackup. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a OciCacheBackup. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new OciCacheBackup 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 OciCacheBackup.
display_name (str) – The value to assign to the display_name property of this OciCacheBackup.
description (str) – The value to assign to the description property of this OciCacheBackup.
compartment_id (str) – The value to assign to the compartment_id property of this OciCacheBackup.
backup_source (str) – The value to assign to the backup_source property of this OciCacheBackup. Allowed values for this property are: “REPLICA”, “PRIMARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OciCacheBackup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
retention_period_in_days (int) – The value to assign to the retention_period_in_days property of this OciCacheBackup.
backup_size_in_gbs (float) – The value to assign to the backup_size_in_gbs property of this OciCacheBackup.
source_cluster_id (str) – The value to assign to the source_cluster_id property of this OciCacheBackup.
cluster_mode (str) – The value to assign to the cluster_mode property of this OciCacheBackup.
cluster_memory_in_gbs (float) – The value to assign to the cluster_memory_in_gbs property of this OciCacheBackup.
shard_count (int) – The value to assign to the shard_count property of this OciCacheBackup.
software_version (str) – The value to assign to the software_version property of this OciCacheBackup.
time_created (datetime) – The value to assign to the time_created property of this OciCacheBackup.
time_updated (datetime) – The value to assign to the time_updated property of this OciCacheBackup.
backup_type (str) – The value to assign to the backup_type property of this OciCacheBackup. 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 OciCacheBackup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OciCacheBackup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OciCacheBackup.

backup_size_in_gbs¶

[Required] Gets the backup_size_in_gbs of this OciCacheBackup. Backup size in GB.

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

backup_source¶

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

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

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

backup_type¶

Gets the backup_type of this OciCacheBackup. 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 OciCacheBackup.
Return type:	str

cluster_memory_in_gbs¶

Gets the cluster_memory_in_gbs of this OciCacheBackup. The amount of memory allocated to the cluster, in gigabytes.

Returns:	The cluster_memory_in_gbs of this OciCacheBackup.
Return type:	float

cluster_mode¶

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

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

compartment_id¶

[Required] Gets the compartment_id of this OciCacheBackup. Backup compartment identifier

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

defined_tags¶

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

description¶

Gets the description of this OciCacheBackup. Backup description

Returns:	The description of this OciCacheBackup.
Return type:	str

display_name¶

[Required] Gets the display_name of this OciCacheBackup. Backup display name

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

freeform_tags¶

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

id¶

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

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

lifecycle_state¶

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

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

retention_period_in_days¶

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

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

shard_count¶

Gets the shard_count of this OciCacheBackup. The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.

Returns:	The shard_count of this OciCacheBackup.
Return type:	int

software_version¶

[Required] Gets the software_version of this OciCacheBackup. The OCI Cache engine version that the cluster is running.

Returns:	The software_version of this OciCacheBackup.
Return type:	str

source_cluster_id¶

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

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

system_tags¶

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

time_created¶

Gets the time_created of this OciCacheBackup. The date and time the backup was created. An RFC3339 formatted datetime string.

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

time_updated¶

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

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