Class KeyTrackingServiceClient (0.35.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   ProtectedResourcesSummaryName name =
       ProtectedResourcesSummaryName.ofProjectLocationKeyRingCryptoKeyName(
           "[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]");
   ProtectedResourcesSummary response =
       keyTrackingServiceClient.getProtectedResourcesSummary(name);
 }

Note: close() needs to be called on the KeyTrackingServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetProtectedResourcesSummary

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 object method variants only take one parameter, a request object, which must be constructed before the call.

  • getProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getProtectedResourcesSummary(ProtectedResourcesSummaryName name)

  • getProtectedResourcesSummary(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getProtectedResourcesSummaryCallable()

SearchProtectedResources

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchProtectedResources(SearchProtectedResourcesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • searchProtectedResources(OrganizationName scope, ResourceName cryptoKey)

  • searchProtectedResources(OrganizationName scope, String cryptoKey)

  • searchProtectedResources(String scope, ResourceName cryptoKey)

  • searchProtectedResources(String scope, String cryptoKey)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchProtectedResourcesPagedCallable()

  • searchProtectedResourcesCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of KeyTrackingServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 KeyTrackingServiceSettings keyTrackingServiceSettings =
     KeyTrackingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeyTrackingServiceClient keyTrackingServiceClient =
     KeyTrackingServiceClient.create(keyTrackingServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 KeyTrackingServiceSettings keyTrackingServiceSettings =
     KeyTrackingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeyTrackingServiceClient keyTrackingServiceClient =
     KeyTrackingServiceClient.create(keyTrackingServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 KeyTrackingServiceSettings keyTrackingServiceSettings =
     KeyTrackingServiceSettings.newHttpJsonBuilder().build();
 KeyTrackingServiceClient keyTrackingServiceClient =
     KeyTrackingServiceClient.create(keyTrackingServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > KeyTrackingServiceClient

Static Methods

create()

public static final KeyTrackingServiceClient create()

Constructs an instance of KeyTrackingServiceClient with default settings.

Returns
Type Description
KeyTrackingServiceClient
Exceptions
Type Description
IOException

create(KeyTrackingServiceSettings settings)

public static final KeyTrackingServiceClient create(KeyTrackingServiceSettings settings)

Constructs an instance of KeyTrackingServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings KeyTrackingServiceSettings
Returns
Type Description
KeyTrackingServiceClient
Exceptions
Type Description
IOException

create(KeyTrackingServiceStub stub)

public static final KeyTrackingServiceClient create(KeyTrackingServiceStub stub)

Constructs an instance of KeyTrackingServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(KeyTrackingServiceSettings).

Parameter
Name Description
stub KeyTrackingServiceStub
Returns
Type Description
KeyTrackingServiceClient

Constructors

KeyTrackingServiceClient(KeyTrackingServiceSettings settings)

protected KeyTrackingServiceClient(KeyTrackingServiceSettings settings)

Constructs an instance of KeyTrackingServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings KeyTrackingServiceSettings

KeyTrackingServiceClient(KeyTrackingServiceStub stub)

protected KeyTrackingServiceClient(KeyTrackingServiceStub stub)
Parameter
Name Description
stub KeyTrackingServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

getProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request)

public final ProtectedResourcesSummary getProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   GetProtectedResourcesSummaryRequest request =
       GetProtectedResourcesSummaryRequest.newBuilder()
           .setName(
               ProtectedResourcesSummaryName.ofProjectLocationKeyRingCryptoKeyName(
                       "[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")
                   .toString())
           .build();
   ProtectedResourcesSummary response =
       keyTrackingServiceClient.getProtectedResourcesSummary(request);
 }
Parameter
Name Description
request GetProtectedResourcesSummaryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ProtectedResourcesSummary

getProtectedResourcesSummary(ProtectedResourcesSummaryName name)

public final ProtectedResourcesSummary getProtectedResourcesSummary(ProtectedResourcesSummaryName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   ProtectedResourcesSummaryName name =
       ProtectedResourcesSummaryName.ofProjectLocationKeyRingCryptoKeyName(
           "[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]");
   ProtectedResourcesSummary response =
       keyTrackingServiceClient.getProtectedResourcesSummary(name);
 }
Parameter
Name Description
name ProtectedResourcesSummaryName

Required. The resource name of the CryptoKey.
Returns
Type Description
ProtectedResourcesSummary

getProtectedResourcesSummary(String name)

public final ProtectedResourcesSummary getProtectedResourcesSummary(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   String name =
       ProtectedResourcesSummaryName.ofProjectLocationKeyRingCryptoKeyName(
               "[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")
           .toString();
   ProtectedResourcesSummary response =
       keyTrackingServiceClient.getProtectedResourcesSummary(name);
 }
Parameter
Name Description
name String

Required. The resource name of the CryptoKey.
Returns
Type Description
ProtectedResourcesSummary

getProtectedResourcesSummaryCallable()

public final UnaryCallable<GetProtectedResourcesSummaryRequest,ProtectedResourcesSummary> getProtectedResourcesSummaryCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   GetProtectedResourcesSummaryRequest request =
       GetProtectedResourcesSummaryRequest.newBuilder()
           .setName(
               ProtectedResourcesSummaryName.ofProjectLocationKeyRingCryptoKeyName(
                       "[PROJECT]", "[LOCATION]", "[KEY_RING]", "[CRYPTO_KEY]")
                   .toString())
           .build();
   ApiFuture<ProtectedResourcesSummary> future =
       keyTrackingServiceClient.getProtectedResourcesSummaryCallable().futureCall(request);
   // Do something.
   ProtectedResourcesSummary response = future.get();
 }
Returns
Type Description
UnaryCallable<GetProtectedResourcesSummaryRequest,ProtectedResourcesSummary>

getSettings()

public final KeyTrackingServiceSettings getSettings()
Returns
Type Description
KeyTrackingServiceSettings

getStub()

public KeyTrackingServiceStub getStub()
Returns
Type Description
KeyTrackingServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

searchProtectedResources(OrganizationName scope, ResourceName cryptoKey)

public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(OrganizationName scope, ResourceName cryptoKey)

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   OrganizationName scope = OrganizationName.of("[ORGANIZATION]");
   ResourceName cryptoKey = OrganizationName.of("[ORGANIZATION]");
   for (ProtectedResource element :
       keyTrackingServiceClient.searchProtectedResources(scope, cryptoKey).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
scope OrganizationName

Required. Resource name of the organization. Example: organizations/123
cryptoKey com.google.api.resourcenames.ResourceName

Required. The resource name of the CryptoKey.
Returns
Type Description
KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse

searchProtectedResources(OrganizationName scope, String cryptoKey)

public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(OrganizationName scope, String cryptoKey)

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   OrganizationName scope = OrganizationName.of("[ORGANIZATION]");
   String cryptoKey = OrganizationName.of("[ORGANIZATION]").toString();
   for (ProtectedResource element :
       keyTrackingServiceClient.searchProtectedResources(scope, cryptoKey).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
scope OrganizationName

Required. Resource name of the organization. Example: organizations/123
cryptoKey String

Required. The resource name of the CryptoKey.
Returns
Type Description
KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse

searchProtectedResources(SearchProtectedResourcesRequest request)

public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(SearchProtectedResourcesRequest request)

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   SearchProtectedResourcesRequest request =
       SearchProtectedResourcesRequest.newBuilder()
           .setScope(OrganizationName.of("[ORGANIZATION]").toString())
           .setCryptoKey(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllResourceTypes(new ArrayList<String>())
           .build();
   for (ProtectedResource element :
       keyTrackingServiceClient.searchProtectedResources(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request SearchProtectedResourcesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse

searchProtectedResources(String scope, ResourceName cryptoKey)

public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(String scope, ResourceName cryptoKey)

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   String scope = OrganizationName.of("[ORGANIZATION]").toString();
   ResourceName cryptoKey = OrganizationName.of("[ORGANIZATION]");
   for (ProtectedResource element :
       keyTrackingServiceClient.searchProtectedResources(scope, cryptoKey).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
scope String

Required. Resource name of the organization. Example: organizations/123
cryptoKey com.google.api.resourcenames.ResourceName

Required. The resource name of the CryptoKey.
Returns
Type Description
KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse

searchProtectedResources(String scope, String cryptoKey)

public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(String scope, String cryptoKey)

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   String scope = OrganizationName.of("[ORGANIZATION]").toString();
   String cryptoKey = OrganizationName.of("[ORGANIZATION]").toString();
   for (ProtectedResource element :
       keyTrackingServiceClient.searchProtectedResources(scope, cryptoKey).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
scope String

Required. Resource name of the organization. Example: organizations/123
cryptoKey String

Required. The resource name of the CryptoKey.
Returns
Type Description
KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse

searchProtectedResourcesCallable()

public final UnaryCallable<SearchProtectedResourcesRequest,SearchProtectedResourcesResponse> searchProtectedResourcesCallable()

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   SearchProtectedResourcesRequest request =
       SearchProtectedResourcesRequest.newBuilder()
           .setScope(OrganizationName.of("[ORGANIZATION]").toString())
           .setCryptoKey(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllResourceTypes(new ArrayList<String>())
           .build();
   while (true) {
     SearchProtectedResourcesResponse response =
         keyTrackingServiceClient.searchProtectedResourcesCallable().call(request);
     for (ProtectedResource element : response.getProtectedResourcesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<SearchProtectedResourcesRequest,SearchProtectedResourcesResponse>

searchProtectedResourcesPagedCallable()

public final UnaryCallable<SearchProtectedResourcesRequest,KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse> searchProtectedResourcesPagedCallable()

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (KeyTrackingServiceClient keyTrackingServiceClient = KeyTrackingServiceClient.create()) {
   SearchProtectedResourcesRequest request =
       SearchProtectedResourcesRequest.newBuilder()
           .setScope(OrganizationName.of("[ORGANIZATION]").toString())
           .setCryptoKey(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllResourceTypes(new ArrayList<String>())
           .build();
   ApiFuture<ProtectedResource> future =
       keyTrackingServiceClient.searchProtectedResourcesPagedCallable().futureCall(request);
   // Do something.
   for (ProtectedResource element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<SearchProtectedResourcesRequest,SearchProtectedResourcesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()