Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class AutonomousDatabaseBackupProperties.
Properties of the Autonomous Database Backup resource.
Generated from protobuf message google.cloud.oracledatabase.v1.AutonomousDatabaseBackupProperties
Namespace
Google \ Cloud \ OracleDatabase \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ ocid |
string
Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle |
↳ retention_period_days |
int
Optional. Retention period in days for the backup. |
↳ compartment_id |
string
Output only. The OCID of the compartment. |
↳ database_size_tb |
float
Output only. The quantity of data in the database, in terabytes. |
↳ db_version |
string
Output only. A valid Oracle Database version for Autonomous Database. |
↳ is_long_term_backup |
bool
Output only. Indicates if the backup is long term backup. |
↳ is_automatic_backup |
bool
Output only. Indicates if the backup is automatic or user initiated. |
↳ is_restorable |
bool
Output only. Indicates if the backup can be used to restore the Autonomous Database. |
↳ key_store_id |
string
Optional. The OCID of the key store of Oracle Vault. |
↳ key_store_wallet |
string
Optional. The wallet name for Oracle Key Vault. |
↳ kms_key_id |
string
Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. |
↳ kms_key_version_id |
string
Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances. |
↳ lifecycle_details |
string
Output only. Additional information about the current lifecycle state. |
↳ lifecycle_state |
int
Output only. The lifecycle state of the backup. |
↳ size_tb |
float
Output only. The backup size in terabytes. |
↳ available_till_time |
Google\Protobuf\Timestamp
Output only. Timestamp until when the backup will be available. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The date and time the backup completed. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. The date and time the backup started. |
↳ type |
int
Output only. The type of the backup. |
↳ vault_id |
string
Optional. The OCID of the vault. |
getOcid
Output only. OCID of the Autonomous Database backup.
https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
| Returns | |
|---|---|
| Type | Description |
string |
|
setOcid
Output only. OCID of the Autonomous Database backup.
https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetentionPeriodDays
Optional. Retention period in days for the backup.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRetentionPeriodDays
Optional. Retention period in days for the backup.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCompartmentId
Output only. The OCID of the compartment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCompartmentId
Output only. The OCID of the compartment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseSizeTb
Output only. The quantity of data in the database, in terabytes.
| Returns | |
|---|---|
| Type | Description |
float |
|
setDatabaseSizeTb
Output only. The quantity of data in the database, in terabytes.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDbVersion
Output only. A valid Oracle Database version for Autonomous Database.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDbVersion
Output only. A valid Oracle Database version for Autonomous Database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsLongTermBackup
Output only. Indicates if the backup is long term backup.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsLongTermBackup
Output only. Indicates if the backup is long term backup.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsAutomaticBackup
Output only. Indicates if the backup is automatic or user initiated.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsAutomaticBackup
Output only. Indicates if the backup is automatic or user initiated.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsRestorable
Output only. Indicates if the backup can be used to restore the Autonomous Database.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsRestorable
Output only. Indicates if the backup can be used to restore the Autonomous Database.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyStoreId
Optional. The OCID of the key store of Oracle Vault.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKeyStoreId
Optional. The OCID of the key store of Oracle Vault.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyStoreWallet
Optional. The wallet name for Oracle Key Vault.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKeyStoreWallet
Optional. The wallet name for Oracle Key Vault.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKeyId
Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKeyId
Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKeyVersionId
Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKeyVersionId
Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLifecycleDetails
Output only. Additional information about the current lifecycle state.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLifecycleDetails
Output only. Additional information about the current lifecycle state.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLifecycleState
Output only. The lifecycle state of the backup.
| Returns | |
|---|---|
| Type | Description |
int |
|
setLifecycleState
Output only. The lifecycle state of the backup.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSizeTb
Output only. The backup size in terabytes.
| Returns | |
|---|---|
| Type | Description |
float |
|
setSizeTb
Output only. The backup size in terabytes.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvailableTillTime
Output only. Timestamp until when the backup will be available.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasAvailableTillTime
clearAvailableTillTime
setAvailableTillTime
Output only. Timestamp until when the backup will be available.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. The date and time the backup completed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. The date and time the backup completed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. The date and time the backup started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. The date and time the backup started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Output only. The type of the backup.
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
Output only. The type of the backup.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVaultId
Optional. The OCID of the vault.
| Returns | |
|---|---|
| Type | Description |
string |
|
setVaultId
Optional. The OCID of the vault.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|