Method: projects.locations.jobs.snapshot

Snapshot the state of a streaming job.

POST https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot

The URL uses gRPC Transcoding syntax.

Parameters

Parameters
`projectId`	`string` The project which owns the job to be snapshotted.
`location`	`string` The location that contains this job.
`jobId`	`string` The job to be snapshotted.

projectId

string

The project which owns the job to be snapshotted.

location

string

The location that contains this job.

jobId

string

The job to be snapshotted.

The request body contains data with the following structure:

JSON representation
{ "ttl" : string , "snapshotSources" : boolean , "description" : string }

Fields

Fields
`ttl`	`string ( Duration format)` TTL for the snapshot. A duration in seconds with up to nine fractional digits, ending with ' `s` '. Example: `"3.5s"` .
`snapshotSources`	`boolean` If true, perform snapshots for sources which support this.
`description`	`string` User specified description of the snapshot. Maybe empty.

ttl

string ( Duration format)

TTL for the snapshot.

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

snapshotSources

boolean

If true, perform snapshots for sources which support this.

description

string

User specified description of the snapshot. Maybe empty.

If successful, the response body contains an instance of Snapshot .

Requires one of the following OAuth scopes:

For more information, see the Authentication Overview .