REST Resource: projects.locations.backups

Resource: Backup

A Cloud Filestore backup.

JSON representation
{
  "name": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "labels": {
    string: string,
    ...
  },
  "capacityGb": string,
  "storageBytes": string,
  "sourceInstance": string,
  "sourceFileShare": string,
  "sourceInstanceTier": enum (Tier),
  "downloadBytes": string
}
Fields
name

string

Output only. The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}.

description

string

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

state

enum (State)

Output only. The backup state.

createTime

string (Timestamp format)

Output only. The time when the backup 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".

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" }.

capacityGb

string (int64 format)

Output only. Capacity of the backup. This would be the size of the file share when the backup is restored.

storageBytes

string (int64 format)

Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

sourceInstance

string

The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup.

sourceFileShare

string

Name of the file share in the source Cloud Filestore instance that the backup is created from.

sourceInstanceTier

enum (Tier)

Output only. The service tier of the source Cloud Filestore instance that this backup is created from.

downloadBytes

string (int64 format)

Output only. Amount of bytes that will be downloaded if the backup is restored

State

The backup state.

Enums
STATE_UNSPECIFIED State not set.
CREATING Backup is being created.
FINALIZING Backup has been taken and the operation is being finalized. At this point, changes to the file share will not be reflected in the backup.
READY Backup is available for use.
DELETING Backup is being deleted.

Methods

create

Creates a backup.

delete

Deletes a backup.

get

Gets the details of a specific backup.

list

Lists all backups in a project for either a specified location or for all locations.

patch

Updates the settings of a specific backup.