KMS Inventory v1 API - Class KeyTrackingService.KeyTrackingServiceBase (1.6.0)

[BindServiceMethod(typeof(KeyTrackingService), "BindService")]
public abstract class KeyTrackingService.KeyTrackingServiceBase

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

Base class for server-side implementations of KeyTrackingService

Inheritance

object > KeyTrackingService.KeyTrackingServiceBase

Namespace

Google.Cloud.Kms.Inventory.V1

Assembly

Google.Cloud.Kms.Inventory.V1.dll

Methods

GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest, ServerCallContext)

public virtual Task<ProtectedResourcesSummary> GetProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request, ServerCallContext context)

Returns aggregate information about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey]. By default, summary of resources within the same Cloud organization as the key will be returned, which requires the KMS organization service account to be configured(refer https://docs.cloud.google.com/kms/docs/view-key-usage#required-roles). If the KMS organization service account is not configured or key's project is not part of an organization, set [fallback_scope][google.cloud.kms.inventory.v1.GetProtectedResourcesSummaryRequest.fallback_scope] to FALLBACK_SCOPE_PROJECT to retrieve a summary of protected resources within the key's project.

Parameters
Name Description
request GetProtectedResourcesSummaryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskProtectedResourcesSummary

The response to send back to the client (wrapped by a task).

SearchProtectedResources(SearchProtectedResourcesRequest, ServerCallContext)

public virtual Task<SearchProtectedResourcesResponse> SearchProtectedResources(SearchProtectedResourcesRequest request, ServerCallContext context)

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

Parameters
Name Description
request SearchProtectedResourcesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSearchProtectedResourcesResponse

The response to send back to the client (wrapped by a task).