Method: 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.

HTTP request

GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/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.

stageId

string

The stage for which to fetch information.

Query parameters

Parameters
pageSize

integer

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

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)

Upper time bound of work items to include, by start 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".

Request body

The request body must be empty.

Response body

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

Information about the workers and work items within a stage.

JSON representation
{
  "workers": [
    {
      object (WorkerDetails)
    }
  ],
  "nextPageToken": string
}
Fields
workers[]

object (WorkerDetails)

Workers that have done work on the stage.

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.

WorkerDetails

Information about a worker

JSON representation
{
  "workerName": string,
  "workItems": [
    {
      object (WorkItemDetails)
    }
  ]
}
Fields
workerName

string

Name of this worker

workItems[]

object (WorkItemDetails)

Work items processed by this worker, sorted by time.

WorkItemDetails

Information about an individual work item execution.

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

string

Name of this work item.

attemptId

string

Attempt ID of this work item

startTime

string (Timestamp format)

Start time of this work item attempt.

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 work item attempt.

If the work item is completed, this is the actual end time of the work item. 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".

state

enum (ExecutionState)

State of this work item.

progress

object (ProgressTimeseries)

Progress of this work item.

metrics[]

object (MetricUpdate)

Metrics for this work item.