searchStages method

Future<SearchSessionSparkApplicationStagesResponse> searchStages(String name, { int? pageSize, String? pageToken, String? parent, String? stageStatus, String? summaryMetricsMask, String? $fields, })

Obtain data corresponding to stages for a Spark Application.

Request parameters:

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

pageSize - Optional. Maximum number of stages (paging based on stage_id) 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 SearchSessionSparkApplicationStages call. Provide this token to retrieve the subsequent page.

parent - Required. Parent (Session) resource reference.

stageStatus - Optional. List only stages in the given state. Possible string values are:

• "STAGE_STATUS_UNSPECIFIED"
• "STAGE_STATUS_ACTIVE"
• "STAGE_STATUS_COMPLETE"
• "STAGE_STATUS_FAILED"
• "STAGE_STATUS_PENDING"
• "STAGE_STATUS_SKIPPED"

summaryMetricsMask - Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

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

Completes with a SearchSessionSparkApplicationStagesResponse.

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<SearchSessionSparkApplicationStagesResponse> searchStages(
  core.String name, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? parent,
  core.String? stageStatus,
  core.String? summaryMetricsMask,
  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 (stageStatus != null) 'stageStatus': [stageStatus],
    if (summaryMetricsMask != null)
      'summaryMetricsMask': [summaryMetricsMask],
    if ($fields != null) 'fields': [$fields],
  };

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

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