GOgoogle
projects

POST /v1b3/projects/{projectId}/jobs/{jobId}:snapshot

Changed on

Snapshot the state of a streaming job. # IAM Permissions Requires the dataflow.jobs.snapshot permission on the job.

Request

  • Base URL
    https://dataflow.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/compute
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/compute
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

The project which owns the job to be snapshotted.

jobIdstring required

The job to be snapshotted.

Request body

descriptionstring

User specified description of the snapshot. Maybe empty.

locationstring

The location that contains this job.

snapshotSourcesboolean

If true, perform snapshots for sources which support this.

ttlstring google-duration

TTL for the snapshot.

Response

Successful response

creationTimestring google-datetime

The time this snapshot was created.

descriptionstring

User specified description of the snapshot. Maybe empty.

diskSizeBytesstring int64

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

idstring

The unique ID of this snapshot.

projectIdstring

The project this snapshot belongs to.

regionstring

Cloud region where this snapshot lives in, e.g., "us-central1".

sourceJobIdstring

The job this snapshot was created from.

state'UNKNOWN_SNAPSHOT_STATE' | 'PENDING' | 'RUNNING' | 'READY' | 'FAILED' | 'DELETED'

State of the snapshot.

ttlstring google-duration

The time after which this snapshot will be automatically deleted.

Changes

  • 69a3fb1fef85Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

  • e94d44227b2eRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c