Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class Backup.
Message describing Backup object
Generated from protobuf message google.cloud.alloydb.v1.Backup
Namespace
Google \ Cloud \ AlloyDb \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The name of the backup resource with the format: * * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?
, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122
. The prefix of the backup resource name is the name of the parent resource: * * projects/{project}/locations/{region}
↳ display_name
string
User-settable and human-readable display name for the Backup.
↳ uid
string
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
↳ create_time
↳ update_time
↳ delete_time
↳ labels
↳ state
int
Output only. The current state of the backup.
↳ type
int
The backup type, which suggests the trigger for the backup.
↳ description
string
User-provided description of the backup.
↳ cluster_uid
string
Output only. The system-generated UID of the cluster which was used to create this resource.
↳ cluster_name
string
Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
↳ reconciling
bool
Output only. Reconciling ( https://google.aip.dev/128#reconciliation ), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
↳ encryption_config
EncryptionConfig
Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
↳ encryption_info
↳ etag
↳ annotations
array| Google\Protobuf\Internal\MapField
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
↳ size_bytes
int|string
Output only. The size of the backup in bytes.
↳ expiry_time
Google\Protobuf\Timestamp
Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
↳ expiry_quantity
Backup\QuantityBasedExpiry
Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ database_version
int
Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
↳ tags
array| Google\Protobuf\Internal\MapField
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
getName
Output only. The name of the backup resource with the format:
- projects/{project}/locations/{region}/backups/{backup_id}
where the cluster and backup ID segments should satisfy the regex
expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122 .
The prefix of the backup resource name is the name of the parent resource:
- projects/{project}/locations/{region}
string
setName
Output only. The name of the backup resource with the format:
- projects/{project}/locations/{region}/backups/{backup_id}
where the cluster and backup ID segments should satisfy the regex
expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122 .
The prefix of the backup resource name is the name of the parent resource:
- projects/{project}/locations/{region}
var
string
$this
getDisplayName
User-settable and human-readable display name for the Backup.
string
setDisplayName
User-settable and human-readable display name for the Backup.
var
string
$this
getUid
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
string
setUid
Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
var
string
$this
getCreateTime
Output only. Create time stamp
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time stamp
$this
getUpdateTime
Output only. Update time stamp
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time stamp
$this
getDeleteTime
Output only. Delete time stamp
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. Delete time stamp
$this
getLabels
Labels as key value pairs
setLabels
Labels as key value pairs
$this
getState
Output only. The current state of the backup.
int
setState
Output only. The current state of the backup.
var
int
$this
getType
The backup type, which suggests the trigger for the backup.
int
setType
The backup type, which suggests the trigger for the backup.
var
int
$this
getDescription
User-provided description of the backup.
string
setDescription
User-provided description of the backup.
var
string
$this
getClusterUid
Output only. The system-generated UID of the cluster which was used to create this resource.
string
setClusterUid
Output only. The system-generated UID of the cluster which was used to create this resource.
var
string
$this
getClusterName
Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
string
setClusterName
Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
var
string
$this
getReconciling
Output only. Reconciling ( https://google.aip.dev/128#reconciliation ), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
bool
setReconciling
Output only. Reconciling ( https://google.aip.dev/128#reconciliation ), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
var
bool
$this
getEncryptionConfig
Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
$this
getEncryptionInfo
Output only. The encryption information for the backup.
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Output only. The encryption information for the backup.
$this
getEtag
For Resource freshness validation ( https://google.aip.dev/154 )
string
setEtag
For Resource freshness validation ( https://google.aip.dev/154 )
var
string
$this
getAnnotations
Annotations to allow client tools to store small amount of arbitrary data.
This is distinct from labels. https://google.aip.dev/128
setAnnotations
Annotations to allow client tools to store small amount of arbitrary data.
This is distinct from labels. https://google.aip.dev/128
$this
getSizeBytes
Output only. The size of the backup in bytes.
int|string
setSizeBytes
Output only. The size of the backup in bytes.
var
int|string
$this
getExpiryTime
Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
hasExpiryTime
clearExpiryTime
setExpiryTime
Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
$this
getExpiryQuantity
Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
hasExpiryQuantity
clearExpiryQuantity
setExpiryQuantity
Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$this
getDatabaseVersion
Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
int
setDatabaseVersion
Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
var
int
$this
getTags
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:
"123/environment": "production",
"123/costCenter": "marketing"
setTags
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:
"123/environment": "production",
"123/costCenter": "marketing"
$this
