Method: googleapis.dataflow.v1b3.projects.locations.jobs.stages.getExecutionDetails

Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice.

Arguments

Parameters
jobId

string

Required. The job to get execution details for.

location

string

Required. The regional endpoint that contains the job specified by job_id.

projectId

string

Required. A project id.

stageId

string

Required. The stage for which to fetch information.

endTime

string (Timestamp format)

Upper time bound of work items to include, by start time.

pageSize

integer (int32 format)

If specified, determines the maximum number of work items to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

pageToken

string

If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

startTime

string (Timestamp format)

Lower time bound of work items to include, by start time.

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

Subworkflow snippet

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

YAML

- getExecutionDetails:
    call: googleapis.dataflow.v1b3.projects.locations.jobs.stages.getExecutionDetails
    args:
        jobId: ...
        location: ...
        projectId: ...
        stageId: ...
        endTime: ...
        pageSize: ...
        pageToken: ...
        startTime: ...
    result: getExecutionDetailsResult

JSON

[
  {
    "getExecutionDetails": {
      "call": "googleapis.dataflow.v1b3.projects.locations.jobs.stages.getExecutionDetails",
      "args": {
        "jobId": "...",
        "location": "...",
        "projectId": "...",
        "stageId": "...",
        "endTime": "...",
        "pageSize": "...",
        "pageToken": "...",
        "startTime": "..."
      },
      "result": "getExecutionDetailsResult"
    }
  }
]