ExportOpensearchClusterBackupDetails¶
- class oci.opensearch.models.ExportOpensearchClusterBackupDetails(**kwargs)¶
Bases:
objectInformation about the cluster backup to export.
Methods:
__init__(**kwargs)Initializes a new ExportOpensearchClusterBackupDetails object with values from keyword arguments.
Attributes:
Gets the compartment_id of this ExportOpensearchClusterBackupDetails.
Gets the defined_tags of this ExportOpensearchClusterBackupDetails.
Gets the freeform_tags of this ExportOpensearchClusterBackupDetails.
[Required] Gets the object_storage_bucket_name of this ExportOpensearchClusterBackupDetails.
[Required] Gets the object_storage_namespace of this ExportOpensearchClusterBackupDetails.
Gets the object_storage_prefix of this ExportOpensearchClusterBackupDetails.
[Required] Gets the prefix of this ExportOpensearchClusterBackupDetails.
[Required] Gets the repository_name of this ExportOpensearchClusterBackupDetails.
[Required] Gets the snapshot_name of this ExportOpensearchClusterBackupDetails.
- __init__(**kwargs)¶
Initializes a new ExportOpensearchClusterBackupDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this ExportOpensearchClusterBackupDetails.
object_storage_namespace (str) – The value to assign to the object_storage_namespace property of this ExportOpensearchClusterBackupDetails.
object_storage_bucket_name (str) – The value to assign to the object_storage_bucket_name property of this ExportOpensearchClusterBackupDetails.
object_storage_prefix (str) – The value to assign to the object_storage_prefix property of this ExportOpensearchClusterBackupDetails.
snapshot_name (str) – The value to assign to the snapshot_name property of this ExportOpensearchClusterBackupDetails.
repository_name (str) – The value to assign to the repository_name property of this ExportOpensearchClusterBackupDetails.
prefix (str) – The value to assign to the prefix property of this ExportOpensearchClusterBackupDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ExportOpensearchClusterBackupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExportOpensearchClusterBackupDetails.
- property compartment_id¶
Gets the compartment_id of this ExportOpensearchClusterBackupDetails. The OCID of the compartment where the Object Storage resources for the cluster backup are located.
- Returns
The compartment_id of this ExportOpensearchClusterBackupDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ExportOpensearchClusterBackupDetails. 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 ExportOpensearchClusterBackupDetails.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this ExportOpensearchClusterBackupDetails. 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 ExportOpensearchClusterBackupDetails.
- Return type
dict(str, str)
- property object_storage_bucket_name¶
[Required] Gets the object_storage_bucket_name of this ExportOpensearchClusterBackupDetails. The name of the Object Storage bucket for the cluster backup export operation.
- Returns
The object_storage_bucket_name of this ExportOpensearchClusterBackupDetails.
- Return type
str
- property object_storage_namespace¶
[Required] Gets the object_storage_namespace of this ExportOpensearchClusterBackupDetails. The Object Storage namespace for the cluster backup export operation.
- Returns
The object_storage_namespace of this ExportOpensearchClusterBackupDetails.
- Return type
str
- property object_storage_prefix¶
Gets the object_storage_prefix of this ExportOpensearchClusterBackupDetails. The prefix within the Object Storage bucket for the cluster backup export operation.
- Returns
The object_storage_prefix of this ExportOpensearchClusterBackupDetails.
- Return type
str
- property prefix¶
[Required] Gets the prefix of this ExportOpensearchClusterBackupDetails. The prefix within object storage bucket for the cluster backup export operation.
- Returns
The prefix of this ExportOpensearchClusterBackupDetails.
- Return type
str
- property repository_name¶
[Required] Gets the repository_name of this ExportOpensearchClusterBackupDetails. The name of the repository containing the snapshots for the cluster backup export operation.
- Returns
The repository_name of this ExportOpensearchClusterBackupDetails.
- Return type
str
- property snapshot_name¶
[Required] Gets the snapshot_name of this ExportOpensearchClusterBackupDetails. The name of the snapshot for the cluster backup export operation.
- Returns
The snapshot_name of this ExportOpensearchClusterBackupDetails.
- Return type
str