- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- StageSummary
- StragglerSummary
- Straggler
- StreamingStragglerInfo
- Try it!
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 |
A project id. |
location |
The regional endpoint that contains the job specified by jobId. |
jobId |
The job to get execution details for. |
Query parameters
Parameters | |
---|---|
pageSize |
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 |
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
Information about the execution of a job.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"stages": [
{
object ( |
Fields | |
---|---|
stages[] |
The stages of the job execution. |
nextPageToken |
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.
StageSummary
Information about a particular execution stage of a job.
JSON representation |
---|
{ "stageId": string, "state": enum ( |
Fields | |
---|---|
stageId |
ID of this stage |
state |
State of this stage. |
startTime |
Start time of this stage. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
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: |
progress |
Progress for this stage. Only applicable to Batch jobs. |
metrics[] |
Metrics for this stage. |
stragglerSummary |
Straggler summary for this stage. |
StragglerSummary
Summarized straggler identification details.
JSON representation |
---|
{
"totalStragglerCount": string,
"stragglerCauseCount": {
string: string,
...
},
"recentStragglers": [
{
object ( |
Fields | |
---|---|
totalStragglerCount |
The total count of stragglers. |
stragglerCauseCount |
Aggregated counts of straggler causes, keyed by the string representation of the StragglerCause enum. |
recentStragglers[] |
The most recent stragglers. |
Straggler
Information for a straggler.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field straggler_info . Information useful for straggler identification and debugging. straggler_info can be only one of the following: |
|
batchStraggler |
Batch straggler identification and debugging information. |
streamingStraggler |
Streaming straggler identification and debugging information. |
StreamingStragglerInfo
Information useful for streaming straggler identification and debugging.
JSON representation |
---|
{ "startTime": string, "endTime": string, "workerName": string, "dataWatermarkLag": string, "systemWatermarkLag": string } |
Fields | |
---|---|
startTime |
Start time of this straggler. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
End time of this straggler. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
workerName |
Name of the worker where the straggler was detected. |
dataWatermarkLag |
The event-time watermark lag at the time of the straggler detection. A duration in seconds with up to nine fractional digits, ending with ' |
systemWatermarkLag |
The system watermark lag at the time of the straggler detection. A duration in seconds with up to nine fractional digits, ending with ' |