Request the job status. To request the status of a job, we recommend
using projects.locations.jobs.getMetrics with a regional endpoint.
Using projects.jobs.getMetrics is not recommended, as you can only
request the status of jobs that are running in us-central1.
Arguments
| Parameters | |
|---|---|
| jobId | 
 Required. The job to get metrics for. 
 | 
| projectId | 
 Required. A project id. 
 | 
| location | 
 The regional endpoint that contains the job specified by job_id. 
 | 
| startTime | 
 Return only metric data that has changed since this time. Default is to return all information about all metrics for the job. 
 | 
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 JobMetrics.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- getMetrics: call: googleapis.dataflow.v1b3.projects.jobs.getMetrics args: jobId: ... projectId: ... location: ... startTime: ... result: getMetricsResult
JSON
[ { "getMetrics": { "call": "googleapis.dataflow.v1b3.projects.jobs.getMetrics", "args": { "jobId": "...", "projectId": "...", "location": "...", "startTime": "..." }, "result": "getMetricsResult" } } ]