Method: projects.locations.jobs.getExecutionDetails

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

HTTP request

GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

A project id.

location

string

The regional endpoint that contains the job specified by jobId.

jobId

string

The job to get execution details for.

Query parameters

Parameters
pageSize

integer

If specified, determines the maximum number of stages 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 nextPageToken returned by an earlier call. This will cause the next page of results to be returned.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Information about the execution of a job.

JSON representation
{
  "stages": [
    {
      object (StageSummary)
    }
  ],
  "nextPageToken": string
}
Fields
stages[]

object (StageSummary)

The stages of the job execution.

nextPageToken

string

If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with pageToken set to this value.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

StageSummary

Information about a particular execution stage of a job.

JSON representation
{
  "stageId": string,
  "state": enum (ExecutionState),
  "startTime": string,
  "endTime": string,
  "progress": {
    object (ProgressTimeseries)
  },
  "metrics": [
    {
      object (MetricUpdate)
    }
  ]
}
Fields
stageId

string

ID of this stage

state

enum (ExecutionState)

State of this stage.

startTime

string (Timestamp format)

Start time of this stage.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

End time of this stage.

If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

progress

object (ProgressTimeseries)

Progress for this stage. Only applicable to Batch jobs.

metrics[]

object (MetricUpdate)

Metrics for this stage.