KMS Inventory v1 API - Class KeyTrackingServiceClientImpl (1.4.0)

public sealed class KeyTrackingServiceClientImpl : KeyTrackingServiceClient

Reference documentation and code samples for the KMS Inventory v1 API class KeyTrackingServiceClientImpl.

KeyTrackingService client wrapper implementation, for convenient use.

Inheritance

object > KeyTrackingServiceClient > KeyTrackingServiceClientImpl

Namespace

Google.Cloud.Kms.Inventory.V1

Assembly

Google.Cloud.Kms.Inventory.V1.dll

Remarks

Returns information about the resources in an org that are protected by a given Cloud KMS key via CMEK.

Constructors

KeyTrackingServiceClientImpl(KeyTrackingServiceClient, KeyTrackingServiceSettings, ILogger)

public KeyTrackingServiceClientImpl(KeyTrackingService.KeyTrackingServiceClient grpcClient, KeyTrackingServiceSettings settings, ILogger logger)

Constructs a client wrapper for the KeyTrackingService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient KeyTrackingServiceKeyTrackingServiceClient

The underlying gRPC client.
settings KeyTrackingServiceSettings

The base KeyTrackingServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override KeyTrackingService.KeyTrackingServiceClient GrpcClient { get; }

The underlying gRPC KeyTrackingService client

Property Value
Type Description
KeyTrackingServiceKeyTrackingServiceClient
Overrides

Methods

GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest, CallSettings)

public override ProtectedResourcesSummary GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request, CallSettings callSettings = null)

Returns aggregate information about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.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.

Parameters
Name Description
request GetProtectedResourcesSummaryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ProtectedResourcesSummary

The RPC response.
Overrides

GetProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest, CallSettings)

public override Task<ProtectedResourcesSummary> GetProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest request, CallSettings callSettings = null)

Returns aggregate information about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.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.

Parameters
Name Description
request GetProtectedResourcesSummaryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProtectedResourcesSummary

A Task containing the RPC response.
Overrides

SearchProtectedResources(SearchProtectedResourcesRequest, CallSettings)

public override PagedEnumerable<SearchProtectedResourcesResponse, ProtectedResource> SearchProtectedResources(SearchProtectedResourcesRequest request, CallSettings callSettings = null)

Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization.

Parameters
Name Description
request SearchProtectedResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchProtectedResourcesResponseProtectedResource

A pageable sequence of ProtectedResource resources.
Overrides

SearchProtectedResourcesAsync(SearchProtectedResourcesRequest, CallSettings)

public override PagedAsyncEnumerable<SearchProtectedResourcesResponse, ProtectedResource> SearchProtectedResourcesAsync(SearchProtectedResourcesRequest request, CallSettings callSettings = null)

Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization.

Parameters
Name Description
request SearchProtectedResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchProtectedResourcesResponseProtectedResource

A pageable asynchronous sequence of ProtectedResource resources.
Overrides