KMS Inventory v1 API - Class KeyTrackingService.KeyTrackingServiceClient (1.3.0)

public class KeyTrackingService.KeyTrackingServiceClient : ClientBase<KeyTrackingService.KeyTrackingServiceClient>

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

Client for KeyTrackingService

Inheritance

object > ClientBase > ClientBaseKeyTrackingServiceKeyTrackingServiceClient > KeyTrackingService.KeyTrackingServiceClient

Namespace

Google.Cloud.Kms.Inventory.V1

Assembly

Google.Cloud.Kms.Inventory.V1.dll

Constructors

KeyTrackingServiceClient()

protected KeyTrackingServiceClient()

Protected parameterless constructor to allow creation of test doubles.

KeyTrackingServiceClient(CallInvoker)

public KeyTrackingServiceClient(CallInvoker callInvoker)

Creates a new client for KeyTrackingService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

KeyTrackingServiceClient(ChannelBase)

public KeyTrackingServiceClient(ChannelBase channel)

Creates a new client for KeyTrackingService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

KeyTrackingServiceClient(ClientBaseConfiguration)

protected KeyTrackingServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest, CallOptions)

public virtual ProtectedResourcesSummary GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ProtectedResourcesSummary

The response received from the server.

GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest, Metadata, DateTime?, CancellationToken)

public virtual ProtectedResourcesSummary GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ProtectedResourcesSummary

The response received from the server.

GetProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest, CallOptions)

public virtual AsyncUnaryCall<ProtectedResourcesSummary> GetProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallProtectedResourcesSummary

The call object.

GetProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ProtectedResourcesSummary> GetProtectedResourcesSummaryAsync(GetProtectedResourcesSummaryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallProtectedResourcesSummary

The call object.

NewInstance(ClientBaseConfiguration)

protected override KeyTrackingService.KeyTrackingServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
KeyTrackingServiceKeyTrackingServiceClient
Overrides

SearchProtectedResources(SearchProtectedResourcesRequest, CallOptions)

public virtual SearchProtectedResourcesResponse SearchProtectedResources(SearchProtectedResourcesRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchProtectedResourcesResponse

The response received from the server.

SearchProtectedResources(SearchProtectedResourcesRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchProtectedResourcesResponse SearchProtectedResources(SearchProtectedResourcesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchProtectedResourcesResponse

The response received from the server.

SearchProtectedResourcesAsync(SearchProtectedResourcesRequest, CallOptions)

public virtual AsyncUnaryCall<SearchProtectedResourcesResponse> SearchProtectedResourcesAsync(SearchProtectedResourcesRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchProtectedResourcesResponse

The call object.

SearchProtectedResourcesAsync(SearchProtectedResourcesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchProtectedResourcesResponse> SearchProtectedResourcesAsync(SearchProtectedResourcesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSearchProtectedResourcesResponse

The call object.