REST Resource: projects.locations.backupVaults.backups

Resource: Backup

A NetApp Backup.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "description": string,
  "volumeUsageBytes": string,
  "backupType": enum (Type),
  "sourceVolume": string,
  "createTime": string,
  "labels": {
    string: string,
    ...
  },
  "chainStorageBytes": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "volumeRegion": string,
  "backupRegion": string,
  "enforcedRetentionEndTime": string,
  "sourceSnapshot": string
}
Fields
name

string

Identifier. The resource name of the backup. Format: projects/{projectId}/locations/{location}/backupVaults/{backupVaultId}/backups/{backupId}.
state

enum (State)

Output only. The backup state.
description

string

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
volumeUsageBytes

string (int64 format)

Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
backupType

enum (Type)

Output only. Type of backup, manually created or created by a backup policy.
sourceVolume

string

Volume full name of this backup belongs to. Format: projects/{projects_id}/locations/{location}/volumes/{volumeId}
createTime

string (Timestamp format)

Output only. The time when the backup was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Resource labels to represent user provided metadata.

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

string (int64 format)

Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
satisfiesPzs

boolean

Output only. Reserved for future use
satisfiesPzi

boolean

Output only. Reserved for future use
volumeRegion

string

Output only. Region of the volume from which the backup was created. Format: projects/{projectId}/locations/{location}
backupRegion

string

Output only. Region in which backup is stored. Format: projects/{projectId}/locations/{location}
enforcedRetentionEndTime

string (Timestamp format)

Output only. The time until which the backup is not deletable.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
sourceSnapshot

string

If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: projects/{projectId}/locations/{location}/volumes/{volumeId}/snapshots/{snapshotId}

State

The Backup States

Enums
STATE_UNSPECIFIED State not set.
CREATING Backup is being created. While in this state, the snapshot for the backup point-in-time may not have been created yet, and so the point-in-time may not have been fixed.
UPLOADING Backup is being uploaded. While in this state, none of the writes to the volume will be included in the backup.
READY Backup is available for use.
DELETING Backup is being deleted.
ERROR Backup is not valid and cannot be used for creating new volumes or restoring existing volumes.
UPDATING Backup is being updated.

Type

Backup types.

Enums
TYPE_UNSPECIFIED Unspecified backup type.
MANUAL Manual backup type.
SCHEDULED Scheduled backup type.

Methods

create

 Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request.

delete

 Warning!

get

 Returns the description of the specified backup

list

 Returns descriptions of all backups for a backupVault.

patch

 Update backup with full spec.