list method

Future<ListWorkspacesResponse> list({
  1. int? pageSize,
  2. String? pageToken,
  3. String? $fields,
})

Lists workspaces for the user.

Request parameters:

pageSize - The maximum number of workspaces to return. The service may return fewer than this value. If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.

pageToken - A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

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

Completes with a ListWorkspacesResponse.

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

  const _url = 'v1alpha1/workspaces';

  final _response = await _requester.request(
    _url,
    'GET',
    queryParams: _queryParams,
  );
  return ListWorkspacesResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}