REST Resource: projects.locations.instances.snapshots

Resource: Snapshot

A Cloud Filestore snapshot.

JSON representation
{
  "name": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "labels": {
    string: string,
    ...
  },
  "filesystemUsedBytes": string
}
Fields
name

string

Output only. The resource name of the snapshot, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}/snapshots/{snapshotId}.

description

string

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

state

enum (State)

Output only. The snapshot state.

createTime

string (Timestamp format)

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

filesystemUsedBytes

string (int64 format)

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

State

The snapshot state.

Enums
STATE_UNSPECIFIED State not set.
CREATING Snapshot is being created.
READY Snapshot is available for use.
DELETING Snapshot is being deleted.

Methods

create

Creates a snapshot.

delete

Deletes a snapshot.

get

Gets the details of a specific snapshot.

list

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

patch

Updates the settings of a specific snapshot.