list method

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

Lists each FirebaseProject accessible to the caller.

The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a pageToken. This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. Use GetFirebaseProject for consistent reads as well as for additional Project details.

Request parameters:

pageSize - The maximum number of Projects to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. This value cannot be negative.

pageToken - Token returned from a previous call to ListFirebaseProjects indicating where in the set of Projects to resume listing.

showDeleted - Optional. Controls whether Projects in the DELETED state should be returned in the response. If not specified, only ACTIVE Projects will be returned.

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

Completes with a ListFirebaseProjectsResponse.

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

  const url_ = 'v1beta1/projects';

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