accessStageAttempt method

Future<AccessSparkApplicationStageAttemptResponse> accessStageAttempt(
  1. String name, {
  2. String? parent,
  3. int? stageAttemptId,
  4. String? stageId,
  5. String? summaryMetricsMask,
  6. String? $fields,
})

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

parent - Required. Parent (Batch) 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 AccessSparkApplicationStageAttemptResponse.

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<AccessSparkApplicationStageAttemptResponse> 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>>{
    if (parent != null) 'parent': [parent],
    if (stageAttemptId != null) 'stageAttemptId': ['${stageAttemptId}'],
    if (stageId != null) 'stageId': [stageId],
    if (summaryMetricsMask != null)
      'summaryMetricsMask': [summaryMetricsMask],
    if ($fields != null) 'fields': [$fields],
  };

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

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