Snapshot

Represents a snapshot of a job.

JSON representation
{
  "id": string,
  "projectId": string,
  "sourceJobId": string,
  "creationTime": string,
  "ttl": string,
  "state": enum (SnapshotState),
  "pubsubMetadata": [
    {
      object (PubsubSnapshotMetadata)
    }
  ],
  "description": string,
  "diskSizeBytes": string
}
Fields
id

string

The unique ID of this snapshot.

projectId

string

The project this snapshot belongs to.

sourceJobId

string

The job this snapshot was created from.

creationTime

string (Timestamp format)

The time this 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".

ttl

string (Duration format)

The time after which this snapshot will be automatically deleted.

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

state

enum (SnapshotState)

State of the snapshot.

pubsubMetadata[]

object (PubsubSnapshotMetadata)

PubSub snapshot metadata.

description

string

User specified description of the snapshot. Maybe empty.

diskSizeBytes

string (int64 format)

The disk byte size of the snapshot. Only available for snapshots in READY state.

SnapshotState

Snapshot state.

Enums
UNKNOWN_SNAPSHOT_STATE Unknown state.
PENDING Snapshot intent to create has been persisted, snapshotting of state has not yet started.
RUNNING Snapshotting is being performed.
READY Snapshot has been created and is ready to be used.
FAILED Snapshot failed to be created.
DELETED Snapshot has been deleted.

PubsubSnapshotMetadata

Represents a Pubsub snapshot.

JSON representation
{
  "topicName": string,
  "snapshotName": string,
  "expireTime": string
}
Fields
topicName

string

The name of the Pubsub topic.

snapshotName

string

The name of the Pubsub snapshot.

expireTime

string (Timestamp format)

The expire time of the Pubsub snapshot.

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