OpensearchClusterBackup¶

class oci.opensearch.models.OpensearchClusterBackup(**kwargs)¶

Bases: object

An OpenSearch cluster backup resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see Cluster Backups.

Attributes

`BACKUP_TYPE_MANUAL`	A constant which can be used with the backup_type property of a OpensearchClusterBackup.
`BACKUP_TYPE_SCHEDULED`	A constant which can be used with the backup_type property of a OpensearchClusterBackup.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OpensearchClusterBackup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OpensearchClusterBackup.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OpensearchClusterBackup.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OpensearchClusterBackup.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OpensearchClusterBackup.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OpensearchClusterBackup.
`backup_size`	Gets the backup_size of this OpensearchClusterBackup.
`backup_type`	[Required] Gets the backup_type of this OpensearchClusterBackup.
`bucket_name`	Gets the bucket_name of this OpensearchClusterBackup.
`compartment_id`	[Required] Gets the compartment_id of this OpensearchClusterBackup.
`defined_tags`	Gets the defined_tags of this OpensearchClusterBackup.
`display_name`	Gets the display_name of this OpensearchClusterBackup.
`freeform_tags`	Gets the freeform_tags of this OpensearchClusterBackup.
`id`	[Required] Gets the id of this OpensearchClusterBackup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OpensearchClusterBackup.
`lifecyle_details`	Gets the lifecyle_details of this OpensearchClusterBackup.
`namespace`	Gets the namespace of this OpensearchClusterBackup.
`prefix`	Gets the prefix of this OpensearchClusterBackup.
`source_cluster_display_name`	Gets the source_cluster_display_name of this OpensearchClusterBackup.
`source_cluster_id`	[Required] Gets the source_cluster_id of this OpensearchClusterBackup.
`system_tags`	Gets the system_tags of this OpensearchClusterBackup.
`time_created`	Gets the time_created of this OpensearchClusterBackup.
`time_expired`	Gets the time_expired of this OpensearchClusterBackup.
`time_updated`	Gets the time_updated of this OpensearchClusterBackup.

Methods

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

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

BACKUP_TYPE_SCHEDULED = 'SCHEDULED'¶: A constant which can be used with the backup_type property of a OpensearchClusterBackup. This constant has a value of “SCHEDULED”

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new OpensearchClusterBackup 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 OpensearchClusterBackup.
display_name (str) – The value to assign to the display_name property of this OpensearchClusterBackup.
compartment_id (str) – The value to assign to the compartment_id property of this OpensearchClusterBackup.
backup_type (str) – The value to assign to the backup_type property of this OpensearchClusterBackup. Allowed values for this property are: “SCHEDULED”, “MANUAL”, ‘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 OpensearchClusterBackup.
time_updated (datetime) – The value to assign to the time_updated property of this OpensearchClusterBackup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpensearchClusterBackup. 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’.
lifecyle_details (str) – The value to assign to the lifecyle_details property of this OpensearchClusterBackup.
source_cluster_id (str) – The value to assign to the source_cluster_id property of this OpensearchClusterBackup.
namespace (str) – The value to assign to the namespace property of this OpensearchClusterBackup.
bucket_name (str) – The value to assign to the bucket_name property of this OpensearchClusterBackup.
prefix (str) – The value to assign to the prefix property of this OpensearchClusterBackup.
time_expired (datetime) – The value to assign to the time_expired property of this OpensearchClusterBackup.
backup_size (float) – The value to assign to the backup_size property of this OpensearchClusterBackup.
source_cluster_display_name (str) – The value to assign to the source_cluster_display_name property of this OpensearchClusterBackup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OpensearchClusterBackup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OpensearchClusterBackup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OpensearchClusterBackup.

backup_size¶

Gets the backup_size of this OpensearchClusterBackup. The size in GB of the cluster backup.

Returns:	The backup_size of this OpensearchClusterBackup.
Return type:	float

backup_type¶

[Required] Gets the backup_type of this OpensearchClusterBackup. Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.

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

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

bucket_name¶

Gets the bucket_name of this OpensearchClusterBackup. The name of the Object Storage bucket for the cluster backup.

Returns:	The bucket_name of this OpensearchClusterBackup.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this OpensearchClusterBackup. The OCID of the compartment where the cluster backup is located.

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

defined_tags¶

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

display_name¶

Gets the display_name of this OpensearchClusterBackup. The name of the cluster backup. Avoid entering confidential information.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this OpensearchClusterBackup. The OCID of the cluster backup.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OpensearchClusterBackup. The current state of the cluster 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 OpensearchClusterBackup.
Return type:	str

lifecyle_details¶

Gets the lifecyle_details of this OpensearchClusterBackup. Additional information about the current lifecycle state of the cluster backup.

Returns:	The lifecyle_details of this OpensearchClusterBackup.
Return type:	str

namespace¶

Gets the namespace of this OpensearchClusterBackup. The Object Storage namespace for the cluster backup.

Returns:	The namespace of this OpensearchClusterBackup.
Return type:	str

prefix¶

Gets the prefix of this OpensearchClusterBackup. The prefix within the Object Storage bucket for the cluster backup.

Returns:	The prefix of this OpensearchClusterBackup.
Return type:	str

source_cluster_display_name¶

Gets the source_cluster_display_name of this OpensearchClusterBackup. The name of the source OpenSearch cluster for the cluster backup.

Returns:	The source_cluster_display_name of this OpensearchClusterBackup.
Return type:	str

source_cluster_id¶

[Required] Gets the source_cluster_id of this OpensearchClusterBackup. The OCID of the source OpenSearch cluster for the cluster backup.

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

system_tags¶

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

time_created¶

Gets the time_created of this OpensearchClusterBackup. The date and time the cluster backup was created. Format defined by RFC3339.

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

time_expired¶

Gets the time_expired of this OpensearchClusterBackup. The date and time the cluster backup expires. Format defined by RFC3339.

Returns:	The time_expired of this OpensearchClusterBackup.
Return type:	datetime

time_updated¶

Gets the time_updated of this OpensearchClusterBackup. The date and time the cluster backup was updated. Format defined by RFC3339.

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