BackupEventDetails¶
- class oci.opensearch.models.BackupEventDetails(**kwargs)¶
Bases:
objectDetails about a cluster backup event.
Attributes:
A constant which can be used with the backup_state property of a BackupEventDetails.
A constant which can be used with the backup_state property of a BackupEventDetails.
A constant which can be used with the backup_state property of a BackupEventDetails.
Gets the backup_size of this BackupEventDetails.
[Required] Gets the backup_state of this BackupEventDetails.
[Required] Gets the cluster_id of this BackupEventDetails.
Gets the snapshot_name of this BackupEventDetails.
[Required] Gets the time_ended of this BackupEventDetails.
[Required] Gets the time_started of this BackupEventDetails.
Methods:
__init__(**kwargs)Initializes a new BackupEventDetails object with values from keyword arguments.
- BACKUP_STATE_DELETED = 'DELETED'¶
A constant which can be used with the backup_state property of a BackupEventDetails. This constant has a value of “DELETED”
- BACKUP_STATE_FAILED = 'FAILED'¶
A constant which can be used with the backup_state property of a BackupEventDetails. This constant has a value of “FAILED”
- BACKUP_STATE_SUCCESS = 'SUCCESS'¶
A constant which can be used with the backup_state property of a BackupEventDetails. This constant has a value of “SUCCESS”
- __init__(**kwargs)¶
Initializes a new BackupEventDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
cluster_id (str) – The value to assign to the cluster_id property of this BackupEventDetails.
backup_state (str) – The value to assign to the backup_state property of this BackupEventDetails. Allowed values for this property are: “DELETED”, “SUCCESS”, “FAILED”
snapshot_name (str) – The value to assign to the snapshot_name property of this BackupEventDetails.
time_started (datetime) – The value to assign to the time_started property of this BackupEventDetails.
time_ended (datetime) – The value to assign to the time_ended property of this BackupEventDetails.
backup_size (float) – The value to assign to the backup_size property of this BackupEventDetails.
- property backup_size¶
Gets the backup_size of this BackupEventDetails. The cluster backup size in GB.
- Returns
The backup_size of this BackupEventDetails.
- Return type
float
- property backup_state¶
[Required] Gets the backup_state of this BackupEventDetails. The result of the cluster backup operation.
Allowed values for this property are: “DELETED”, “SUCCESS”, “FAILED”
- Returns
The backup_state of this BackupEventDetails.
- Return type
str
- property cluster_id¶
[Required] Gets the cluster_id of this BackupEventDetails. The OCID of the OpenSearch cluster for the cluster backup.
- Returns
The cluster_id of this BackupEventDetails.
- Return type
str
- property snapshot_name¶
Gets the snapshot_name of this BackupEventDetails. The name of the cluster backup.
- Returns
The snapshot_name of this BackupEventDetails.
- Return type
str