accessStageAttempt method

Future<AccessSessionSparkApplicationStageAttemptResponse> accessStageAttempt(String name, { String? parent, int? stageAttemptId, String? stageId, String? summaryMetricsMask, String? $fields, })

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

parent - Required. Parent (Session) resource reference.

stageAttemptId - Required. Stage Attempt ID

stageId - Required. Stage ID

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 AccessSessionSparkApplicationStageAttemptResponse.

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<AccessSessionSparkApplicationStageAttemptResponse>
accessStageAttempt(
  core.String name, {
  core.String? parent,
  core.int? stageAttemptId,
  core.String? stageId,
  core.String? summaryMetricsMask,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'parent': ?parent == null ? null : [parent],
    'stageAttemptId': ?stageAttemptId == null ? null : ['${stageAttemptId}'],
    'stageId': ?stageId == null ? null : [stageId],
    'summaryMetricsMask': ?summaryMetricsMask == null
        ? null
        : [summaryMetricsMask],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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