Skip to main content

jobs_execution_details

Creates, updates, deletes, gets or lists a jobs_execution_details resource.

Overview​

Namejobs_execution_details
TypeResource
Idgoogle.dataflow.jobs_execution_details

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
endTimestring (google-datetime)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.
metricsarrayMetrics for this stage.
progressobjectProgress for this stage. Only applicable to Batch jobs. (id: ProgressTimeseries)
stageIdstringID of this stage
startTimestring (google-datetime)Start time of this stage.
statestringState of this stage. (EXECUTION_STATE_UNKNOWN, EXECUTION_STATE_NOT_STARTED, EXECUTION_STATE_RUNNING, EXECUTION_STATE_SUCCEEDED, EXECUTION_STATE_FAILED, EXECUTION_STATE_CANCELLED)
stragglerSummaryobjectStraggler summary for this stage. (id: StragglerSummary)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_jobs_get_execution_detailsselectprojectId, location, jobIdpageSize, pageTokenRequest detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice. # IAM Permissions Requires the dataflow.metrics.get permission on the job.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
jobIdstring
locationstring
projectIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples​

Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice. # IAM Permissions Requires the dataflow.metrics.get permission on the job.

SELECT
endTime,
metrics,
progress,
stageId,
startTime,
state,
stragglerSummary
FROM google.dataflow.jobs_execution_details
WHERE projectId = '{{ projectId }}' -- required
AND location = '{{ location }}' -- required
AND jobId = '{{ jobId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;