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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 |
Google\Protobuf\Timestamp
Output only. The time when the instance was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the instance was updated. |
↳ 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 |
Google\Protobuf\Timestamp
Optional. Time after which the BackupVault resource is locked. |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The description of the BackupVault instance (2048 characters or less).
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
Optional. The description of the BackupVault instance (2048 characters or less).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Resource labels to represent user provided metadata.
No labels currently defined:
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Resource labels to represent user provided metadata.
No labels currently defined:
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time when the instance was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the instance was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time when the instance was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the instance was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeletable
Output only. Set to true when there are no backups nested under this resource.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasDeletable
clearDeletable
setDeletable
Output only. Set to true when there are no backups nested under this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEtag
clearEtag
setEtag
Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The BackupVault resource instance state.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The BackupVault resource instance state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEffectiveTime
Optional. Time after which the BackupVault resource is locked.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEffectiveTime
clearEffectiveTime
setEffectiveTime
Optional. Time after which the BackupVault resource is locked.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupCount
Output only. The number of backups in this backup vault.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setBackupCount
Output only. The number of backups in this backup vault.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTotalStoredBytes
Output only. Total size of the storage used by all backup resources.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setTotalStoredBytes
Output only. Total size of the storage used by all backup resources.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. Output only Immutable after resource creation until resource deletion.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. Output only Immutable after resource creation until resource deletion.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotations
Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setAnnotations
Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|