accessSqlQuery method

Future<AccessSparkApplicationSqlQueryResponse> accessSqlQuery(
  1. String name, {
  2. bool? details,
  3. String? executionId,
  4. String? parent,
  5. bool? planDescription,
  6. String? $fields,
})

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

details - Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

executionId - Required. Execution ID

parent - Required. Parent (Batch) resource reference.

planDescription - Optional. Enables/ disables physical plan description on demand

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

Completes with a AccessSparkApplicationSqlQueryResponse.

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<AccessSparkApplicationSqlQueryResponse> accessSqlQuery(
  core.String name, {
  core.bool? details,
  core.String? executionId,
  core.String? parent,
  core.bool? planDescription,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (details != null) 'details': ['${details}'],
    if (executionId != null) 'executionId': [executionId],
    if (parent != null) 'parent': [parent],
    if (planDescription != null) 'planDescription': ['${planDescription}'],
    if ($fields != null) 'fields': [$fields],
  };

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

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