searchStageAttemptTasks method

Future<SearchSparkApplicationStageAttemptTasksResponse> searchStageAttemptTasks(
  1. String name, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? parent,
  5. bool? sortRuntime,
  6. int? stageAttemptId,
  7. String? stageId,
  8. String? taskStatus,
  9. String? $fields,
})

Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.

Request parameters:

name - Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/batches/\[^/\]+/sparkApplications/\[^/\]+$.

pageSize - Optional. Maximum number of tasks to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

pageToken - Optional. A page token received from a previous ListSparkApplicationStageAttemptTasks call. Provide this token to retrieve the subsequent page.

parent - Required. Parent (Batch) resource reference.

sortRuntime - Optional. Sort the tasks by runtime.

stageAttemptId - Optional. Stage Attempt ID

stageId - Optional. Stage ID

taskStatus - Optional. List only tasks in the state. Possible string values are:

  • "TASK_STATUS_UNSPECIFIED"
  • "TASK_STATUS_RUNNING"
  • "TASK_STATUS_SUCCESS"
  • "TASK_STATUS_FAILED"
  • "TASK_STATUS_KILLED"
  • "TASK_STATUS_PENDING"

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

Completes with a SearchSparkApplicationStageAttemptTasksResponse.

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<SearchSparkApplicationStageAttemptTasksResponse>
    searchStageAttemptTasks(
  core.String name, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? parent,
  core.bool? sortRuntime,
  core.int? stageAttemptId,
  core.String? stageId,
  core.String? taskStatus,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (parent != null) 'parent': [parent],
    if (sortRuntime != null) 'sortRuntime': ['${sortRuntime}'],
    if (stageAttemptId != null) 'stageAttemptId': ['${stageAttemptId}'],
    if (stageId != null) 'stageId': [stageId],
    if (taskStatus != null) 'taskStatus': [taskStatus],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$name') + ':searchStageAttemptTasks';

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