Method: googleapis.dataflow.v1b3.projects.locations.jobs.get

Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using projects.locations.jobs.get with a regional endpoint. Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.

Arguments

Parameters
jobId	string Required. The job ID.
location	string Required. The regional endpoint that contains this job.
projectId	string Required. The ID of the Cloud Platform project that the job belongs to.
view	enum The level of information requested in response.
Enum type. Can be one of the following:
JOB_VIEW_UNKNOWN	The job view to return isn't specified, or is unknown. Responses will contain at least the JOB_VIEW_SUMMARY information, and may contain additional information.
JOB_VIEW_SUMMARY	Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details.
JOB_VIEW_ALL	Request all information available for this job.
JOB_VIEW_DESCRIPTION	Request summary info and limited job description data for steps, labels and environment.

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

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- get:
    call: googleapis.dataflow.v1b3.projects.locations.jobs.get
    args:
        jobId: ...
        location: ...
        projectId: ...
        view: ...
    result: getResult

JSON

[
  {
    "get": {
      "call": "googleapis.dataflow.v1b3.projects.locations.jobs.get",
      "args": {
        "jobId": "...",
        "location": "...",
        "projectId": "...",
        "view": "..."
      },
      "result": "getResult"
    }
  }
]