REST Resource: projects.locations.backupVaults

Resource: BackupVault

Message describing a BackupVault object.

JSON representation 
{
  "name": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "backupCount": string,
  "serviceAccount": string,
  "totalStoredBytes": string,
  "uid": string,
  "annotations": {
    string: string,
    ...
  },
  "accessRestriction": enum (AccessRestriction),
  "description": string,
  "createTime": string,
  "updateTime": string,
  "backupMinimumEnforcedRetentionDuration": string,
  "deletable": boolean,
  "etag": string,
  "effectiveTime": string
}
Fields
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.
labels

map (key: string, value: string)

Optional. Resource labels to represent user provided metadata. No labels currently defined:

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Output only. The BackupVault resource instance state.
backupCount

string (int64 format)

Output only. The number of backups in this backup vault.
serviceAccount

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.
totalStoredBytes

string (int64 format)

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

map (key: string, value: string)

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
accessRestriction

enum (AccessRestriction)

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.
description

string

Optional. The description of the BackupVault instance (2048 characters or less).
createTime

string (Timestamp format)

Output only. The time when the instance was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the instance was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
backupMinimumEnforcedRetentionDuration

string (Duration format)

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
deletable

boolean

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.
effectiveTime

string (Timestamp format)

Optional. Time after which the BackupVault resource is locked.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

State

Holds the state of the backup vault resource.

Enums
STATE_UNSPECIFIED State not set.
CREATING The backup vault is being created.
ACTIVE The backup vault has been created and is fully usable.
DELETING The backup vault is being deleted.
ERROR The backup vault is experiencing an issue and might be unusable.

AccessRestriction

Holds the access restriction for the backup vault.

Enums
ACCESS_RESTRICTION_UNSPECIFIED Access restriction not set. If user does not provide any value or pass this value, it will be changed to WITHIN_ORGANIZATION.
WITHIN_PROJECT Access to or from resources outside your current project will be denied.
WITHIN_ORGANIZATION Access to or from resources outside your current organization will be denied.
UNRESTRICTED No access restriction.
WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA Access to or from resources outside your current organization will be denied except for backup appliance.

Methods

create

 Creates a new BackupVault in a given project and location.

delete

 Deletes a BackupVault.

fetchUsable

 FetchUsableBackupVaults lists usable BackupVaults in a given project and location.

get

 Gets details of a BackupVault.

list

 Lists BackupVaults in a given project and location.

patch

 Updates the settings of a BackupVault.

testIamPermissions

 Returns the caller's permissions on a BackupVault resource.