getProtectedResourcesSummary method

Future<GoogleCloudKmsInventoryV1ProtectedResourcesSummary> getProtectedResourcesSummary(
  1. String name, {
  2. String? $fields,
})

Returns aggregate information about the resources protected by the given Cloud KMS CryptoKey.

Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.

Request parameters:

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

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

Completes with a GoogleCloudKmsInventoryV1ProtectedResourcesSummary.

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<GoogleCloudKmsInventoryV1ProtectedResourcesSummary>
    getProtectedResourcesSummary(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$name') + '/protectedResourcesSummary';

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