list method
Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.
Request parameters:
parent
- Required. The Google Cloud project for which to retrieve key
metadata, in the format projects / *
Value must have pattern ^projects/\[^/\]+$
.
pageSize
- Optional. The maximum number of keys to return. The service
may return fewer than this value. If unspecified, at most 1000 keys will
be returned. The maximum value is 1000; values above 1000 will be coerced
to 1000.
pageToken
- Optional. Pass this into a subsequent request in order to
receive the next page of results.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudKmsInventoryV1ListCryptoKeysResponse.
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<GoogleCloudKmsInventoryV1ListCryptoKeysResponse> 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') + '/cryptoKeys';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudKmsInventoryV1ListCryptoKeysResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}