list method

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

Lists all the PluggableDatabases for the given project, location and Container Database.

Request parameters:

parent - Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: database="projects/{project}/locations/{location}/databases/{database}"

pageSize - Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.

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

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

Completes with a ListPluggableDatabasesResponse.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/pluggableDatabases';

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