Snapshot the state of a streaming job.
Arguments
Parameters | |
---|---|
jobId |
Required. The job to be snapshotted.
|
location |
Required. The location that contains this job.
|
projectId |
Required. The project which owns the job to be snapshotted.
|
body |
Required.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of Snapshot
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- snapshot: call: googleapis.dataflow.v1b3.projects.locations.jobs.snapshot args: jobId: ... location: ... projectId: ... body: description: ... location: ... snapshotSources: ... ttl: ... result: snapshotResult
JSON
[ { "snapshot": { "call": "googleapis.dataflow.v1b3.projects.locations.jobs.snapshot", "args": { "jobId": "...", "location": "...", "projectId": "...", "body": { "description": "...", "location": "...", "snapshotSources": "...", "ttl": "..." } }, "result": "snapshotResult" } } ]