list method

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

Lists Datastore resources in a given project and location.

Request parameters:

parent - Required. The resource name of the location to query for Datastores. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1 Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <. For example, if you are filtering a list of datastores, you can exclude the ones named example-datastore by specifying name != "example-datastore". To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-datastore") (createTime > "2021-04-12T08:15:10.40Z") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-datastore-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-datastore-2")

orderBy - Optional. Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

pageSize - Optional. The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.

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

requestId - Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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

Completes with a ListDatastoresResponse.

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

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

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