- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- WorkerDetails
- WorkItemDetails
- Try it!
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 | |
---|---|
project |
A project id. |
location |
The regional endpoint that contains the job specified by jobId. |
job |
The job to get execution details for. |
stage |
The stage for which to fetch information. |
Query parameters
Parameters | |
---|---|
page |
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. |
page |
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. |
start |
Lower time bound of work items to include, by start time. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
end |
Upper time bound of work items to include, by start time. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
Request body
The request body must be empty.
Response body
Information about the workers and work items within a stage.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"workers": [
{
object ( |
Fields | |
---|---|
workers[] |
Workers that have done work on the stage. |
next |
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
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
WorkerDetails
Information about a worker
JSON representation |
---|
{
"workerName": string,
"workItems": [
{
object ( |
Fields | |
---|---|
worker |
Name of this worker |
work |
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 ( |
Fields | |
---|---|
task |
Name of this work item. |
attempt |
Attempt ID of this work item |
start |
Start time of this work item attempt. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
end |
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. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
state |
State of this work item. |
progress |
Progress of this work item. |
metrics[] |
Metrics for this work item. |
straggler |
Information about straggler detections for this work item. |