list method
List all databases in a specified catalog.
Request parameters:
parent
- Required. The parent, which owns this collection of databases.
Format:
projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/catalogs/\[^/\]+$
.
pageSize
- The maximum number of databases to return. The service may
return fewer than this value. If unspecified, at most 50 databases will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
pageToken
- A page token, received from a previous ListDatabases
call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListDatabases
must match the call that provided
the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListDatabasesResponse.
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<ListDatabasesResponse> list(
core.String parent, {
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],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/databases';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListDatabasesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}