list method

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

Lists CryptoKeyVersions.

Request parameters:

parent - Required. The resource name of the CryptoKey to list, in the format projects / * /locations / * /keyRings / * /cryptoKeys / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/keyRings/\[^/\]+/cryptoKeys/\[^/\]+$.

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 CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

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

view - The fields to include in the response. Possible string values are:

  • "CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED" : Default view for each CryptoKeyVersion. Does not include the attestation field.
  • "FULL" : Provides all fields in each CryptoKeyVersion, including the attestation.

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

Completes with a ListCryptoKeyVersionsResponse.

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

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

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