getExecutionDetails method

Future<StageExecutionDetails> getExecutionDetails(
  1. String projectId,
  2. String location,
  3. String jobId,
  4. String stageId, {
  5. String? endTime,
  6. int? pageSize,
  7. String? pageToken,
  8. String? startTime,
  9. String? $fields,
})

Request detailed information about the execution status of a stage of the job.

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

Request parameters:

projectId - A project id.

location - The regional endpoint that contains the job specified by job_id.

jobId - The job to get execution details for.

stageId - The stage for which to fetch information.

endTime - Upper time bound of work items to include, by start time.

pageSize - 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 - If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

startTime - Lower time bound of work items to include, by start time.

$fields - Selector specifying which fields to include in a partial response.

Completes with a StageExecutionDetails.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<StageExecutionDetails> getExecutionDetails(
  core.String projectId,
  core.String location,
  core.String jobId,
  core.String stageId, {
  core.String? endTime,
  core.int? pageSize,
  core.String? pageToken,
  core.String? startTime,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (endTime != null) 'endTime': [endTime],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (startTime != null) 'startTime': [startTime],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1b3/projects/' +
      commons.escapeVariable('$projectId') +
      '/locations/' +
      commons.escapeVariable('$location') +
      '/jobs/' +
      commons.escapeVariable('$jobId') +
      '/stages/' +
      commons.escapeVariable('$stageId') +
      '/executionDetails';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return StageExecutionDetails.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}