Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class BackupVault.
Message describing a BackupVault object.
Generated from protobuf message google.cloud.backupdr.v1.BackupVault
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Identifier. Name of the backup vault to create. It must have the format "projects/{project}/locations/{location}/backupVaults/{backupvault}"
. {backupvault}
cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
↳ description
string
Optional. The description of the BackupVault instance (2048 characters or less).
↳ labels
array| Google\Protobuf\Internal\MapField
Optional. Resource labels to represent user provided metadata. No labels currently defined:
↳ create_time
↳ update_time
↳ backup_minimum_enforced_retention_duration
Google\Protobuf\Duration
Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
↳ deletable
bool
Output only. Set to true when there are no backups nested under this resource.
↳ etag
string
Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
↳ state
int
Output only. The BackupVault resource instance state.
↳ effective_time
↳ backup_count
int|string
Output only. The number of backups in this backup vault.
↳ service_account
string
Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
↳ total_stored_bytes
int|string
Output only. Total size of the storage used by all backup resources.
↳ uid
string
Output only. Output only Immutable after resource creation until resource deletion.
↳ annotations
array| Google\Protobuf\Internal\MapField
Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
↳ access_restriction
int
Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
getName
Output only. Identifier. Name of the backup vault to create. It must have
the
format "projects/{project}/locations/{location}/backupVaults/{backupvault}"
.
{backupvault}
cannot be changed after creation. It must be between 3-63
characters long and must be unique within the project and location.
string
setName
Output only. Identifier. Name of the backup vault to create. It must have
the
format "projects/{project}/locations/{location}/backupVaults/{backupvault}"
.
{backupvault}
cannot be changed after creation. It must be between 3-63
characters long and must be unique within the project and location.
var
string
$this
getDescription
Optional. The description of the BackupVault instance (2048 characters or less).
string
hasDescription
clearDescription
setDescription
Optional. The description of the BackupVault instance (2048 characters or less).
var
string
$this
getLabels
Optional. Resource labels to represent user provided metadata.
No labels currently defined:
setLabels
Optional. Resource labels to represent user provided metadata.
No labels currently defined:
$this
getCreateTime
Output only. The time when the instance was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the instance was created.
$this
getUpdateTime
Output only. The time when the instance was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the instance was updated.
$this
getBackupMinimumEnforcedRetentionDuration
Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
hasBackupMinimumEnforcedRetentionDuration
clearBackupMinimumEnforcedRetentionDuration
setBackupMinimumEnforcedRetentionDuration
Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
$this
getDeletable
Output only. Set to true when there are no backups nested under this resource.
bool
hasDeletable
clearDeletable
setDeletable
Output only. Set to true when there are no backups nested under this resource.
var
bool
$this
getEtag
Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
string
hasEtag
clearEtag
setEtag
Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
var
string
$this
getState
Output only. The BackupVault resource instance state.
int
setState
Output only. The BackupVault resource instance state.
var
int
$this
getEffectiveTime
Optional. Time after which the BackupVault resource is locked.
hasEffectiveTime
clearEffectiveTime
setEffectiveTime
Optional. Time after which the BackupVault resource is locked.
$this
getBackupCount
Output only. The number of backups in this backup vault.
int|string
setBackupCount
Output only. The number of backups in this backup vault.
var
int|string
$this
getServiceAccount
Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
string
setServiceAccount
Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
var
string
$this
getTotalStoredBytes
Output only. Total size of the storage used by all backup resources.
int|string
setTotalStoredBytes
Output only. Total size of the storage used by all backup resources.
var
int|string
$this
getUid
Output only. Output only Immutable after resource creation until resource deletion.
string
setUid
Output only. Output only Immutable after resource creation until resource deletion.
var
string
$this
getAnnotations
Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
setAnnotations
Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
$this
getAccessRestriction
Optional. Note: This field is added for future use case and will not be supported in the current release.
Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
int
setAccessRestriction
Optional. Note: This field is added for future use case and will not be supported in the current release.
Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
var
int
$this
