OpensearchClusterBackupSummary¶
- class oci.opensearch.models.OpensearchClusterBackupSummary(**kwargs)¶
Bases:
objectThe summary of information about an OpenSearch cluster backup.
Methods:
__init__(**kwargs)Initializes a new OpensearchClusterBackupSummary object with values from keyword arguments.
Attributes:
Gets the backup_size of this OpensearchClusterBackupSummary.
[Required] Gets the backup_type of this OpensearchClusterBackupSummary.
[Required] Gets the compartment_id of this OpensearchClusterBackupSummary.
Gets the defined_tags of this OpensearchClusterBackupSummary.
Gets the display_name of this OpensearchClusterBackupSummary.
Gets the freeform_tags of this OpensearchClusterBackupSummary.
[Required] Gets the id of this OpensearchClusterBackupSummary.
Gets the lifecycle_details of this OpensearchClusterBackupSummary.
[Required] Gets the lifecycle_state of this OpensearchClusterBackupSummary.
Gets the source_cluster_display_name of this OpensearchClusterBackupSummary.
[Required] Gets the source_cluster_id of this OpensearchClusterBackupSummary.
Gets the system_tags of this OpensearchClusterBackupSummary.
Gets the time_created of this OpensearchClusterBackupSummary.
Gets the time_expired of this OpensearchClusterBackupSummary.
Gets the time_updated of this OpensearchClusterBackupSummary.
- __init__(**kwargs)¶
Initializes a new OpensearchClusterBackupSummary 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 OpensearchClusterBackupSummary.
display_name (str) – The value to assign to the display_name property of this OpensearchClusterBackupSummary.
compartment_id (str) – The value to assign to the compartment_id property of this OpensearchClusterBackupSummary.
backup_type (str) – The value to assign to the backup_type property of this OpensearchClusterBackupSummary.
source_cluster_id (str) – The value to assign to the source_cluster_id property of this OpensearchClusterBackupSummary.
time_created (datetime) – The value to assign to the time_created property of this OpensearchClusterBackupSummary.
time_updated (datetime) – The value to assign to the time_updated property of this OpensearchClusterBackupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpensearchClusterBackupSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OpensearchClusterBackupSummary.
time_expired (datetime) – The value to assign to the time_expired property of this OpensearchClusterBackupSummary.
backup_size (float) – The value to assign to the backup_size property of this OpensearchClusterBackupSummary.
source_cluster_display_name (str) – The value to assign to the source_cluster_display_name property of this OpensearchClusterBackupSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OpensearchClusterBackupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OpensearchClusterBackupSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OpensearchClusterBackupSummary.
- property backup_size¶
Gets the backup_size of this OpensearchClusterBackupSummary. The size in GB of the cluster backup.
- Returns
The backup_size of this OpensearchClusterBackupSummary.
- Return type
float
- property backup_type¶
[Required] Gets the backup_type of this OpensearchClusterBackupSummary. Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.
- Returns
The backup_type of this OpensearchClusterBackupSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this OpensearchClusterBackupSummary. The OCID of the compartment where the cluster backup is located.
- Returns
The compartment_id of this OpensearchClusterBackupSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this OpensearchClusterBackupSummary. 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 OpensearchClusterBackupSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this OpensearchClusterBackupSummary. The name of the cluster backup. Avoid entering confidential information.
- Returns
The display_name of this OpensearchClusterBackupSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this OpensearchClusterBackupSummary. 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 OpensearchClusterBackupSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this OpensearchClusterBackupSummary. The OCID of the cluster backup.
- Returns
The id of this OpensearchClusterBackupSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this OpensearchClusterBackupSummary. Additional information about the current lifecycle state of the cluster backup.
- Returns
The lifecycle_details of this OpensearchClusterBackupSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this OpensearchClusterBackupSummary. The current state of the cluster backup.
- Returns
The lifecycle_state of this OpensearchClusterBackupSummary.
- Return type
str
- property source_cluster_display_name¶
Gets the source_cluster_display_name of this OpensearchClusterBackupSummary. The name of the source OpenSearch cluster for the cluster backup.
- Returns
The source_cluster_display_name of this OpensearchClusterBackupSummary.
- Return type
str
- property source_cluster_id¶
[Required] Gets the source_cluster_id of this OpensearchClusterBackupSummary. The OCID of the source OpenSearch cluster for the cluster backup.
- Returns
The source_cluster_id of this OpensearchClusterBackupSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this OpensearchClusterBackupSummary. 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 OpensearchClusterBackupSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this OpensearchClusterBackupSummary. The date and time the cluster backup was created. Format defined by RFC3339.
- Returns
The time_created of this OpensearchClusterBackupSummary.
- Return type
datetime