list method
- String database,
- {int pageSize,
- String filter,
- String pageToken,
- 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/^/
+$".
pageSize
- Number of sessions to be returned in the response. If 0 or
less, defaults to the server's maximum allowed page size.
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".
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.int pageSize,
core.String filter,
core.String pageToken,
core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
var _uploadMedia;
var _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
if (database == null) {
throw new core.ArgumentError("Parameter database is required.");
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
if (filter != null) {
_queryParams["filter"] = [filter];
}
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$database') +
'/sessions';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new ListSessionsResponse.fromJson(data));
}