list method

Future<ListKeyRingsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Lists KeyRings.

Request parameters:

parent - Required. The resource name of the location associated with the KeyRings, in the format projects / * /locations / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.

orderBy - Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

pageSize - Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

pageToken - Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.

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

Completes with a ListKeyRingsResponse.

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

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

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