searchExecutors method

Future<SearchSparkApplicationExecutorsResponse> searchExecutors(
  1. String name, {
  2. String? executorStatus,
  3. int? pageSize,
  4. String? pageToken,
  5. String? parent,
  6. String? $fields,
})

Obtain data corresponding to executors 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/\[^/\]+$.

executorStatus - Optional. Filter to select whether active/ dead or all executors should be selected. Possible string values are:

  • "EXECUTOR_STATUS_UNSPECIFIED"
  • "EXECUTOR_STATUS_ACTIVE"
  • "EXECUTOR_STATUS_DEAD"

pageSize - Optional. Maximum number of executors 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 AccessSparkApplicationExecutorsList call. Provide this token to retrieve the subsequent page.

parent - Required. Parent (Batch) resource reference.

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

Completes with a SearchSparkApplicationExecutorsResponse.

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<SearchSparkApplicationExecutorsResponse> searchExecutors(
  core.String name, {
  core.String? executorStatus,
  core.int? pageSize,
  core.String? pageToken,
  core.String? parent,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (executorStatus != null) 'executorStatus': [executorStatus],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (parent != null) 'parent': [parent],
    if ($fields != null) 'fields': [$fields],
  };

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

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