searchSqlQueries method

Future<SearchSessionSparkApplicationSqlQueriesResponse> searchSqlQueries(
  1. String name, {
  2. bool? details,
  3. List<String>? operationIds,
  4. int? pageSize,
  5. String? pageToken,
  6. String? parent,
  7. bool? planDescription,
  8. String? $fields,
})

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

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

operationIds - Optional. List of Spark Connect operation IDs to filter by if provided.

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

parent - Required. Parent (Session) 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 SearchSessionSparkApplicationSqlQueriesResponse.

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<SearchSessionSparkApplicationSqlQueriesResponse>
searchSqlQueries(
  core.String name, {
  core.bool? details,
  core.List<core.String>? operationIds,
  core.int? pageSize,
  core.String? pageToken,
  core.String? parent,
  core.bool? planDescription,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'details': ?details == null ? null : ['${details}'],
    'operationIds': ?operationIds,
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'parent': ?parent == null ? null : [parent],
    'planDescription': ?planDescription == null
        ? null
        : ['${planDescription}'],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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