list method

Future<ListSessionsResponse> list(
  1. String database, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Lists all sessions in a given database.

Request parameters:

database - Required. The database in which to list sessions. Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+/databases/\[^/\]+$.

filter - An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * labels.key where key is the name of a label Some examples of using filters are: * labels.env:* --> The session has the label "env". * labels.env:dev --> The session has the label "env" and the value of the label contains the string "dev".

pageSize - Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

pageToken - If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

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

Completes with a ListSessionsResponse.

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<ListSessionsResponse> list(
  core.String database, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$database') + '/sessions';

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