Package com.google.cloud.kms.inventory.v1

Class KeyTrackingServiceClient

java.lang.Object
com.google.cloud.kms.inventory.v1.KeyTrackingServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class KeyTrackingServiceClient extends Object implements BackgroundResource
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][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.

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][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

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(ProjectName scope, ResourceName cryptoKey)

  • searchProtectedResources(ProjectName 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.

  • Constructor Details

    • KeyTrackingServiceClient

      protected KeyTrackingServiceClient(KeyTrackingServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • KeyTrackingServiceClient

      protected KeyTrackingServiceClient(KeyTrackingServiceStub stub)

  • Method Details

    • create

      public static final KeyTrackingServiceClient create() throws IOException
      Constructs an instance of KeyTrackingServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final KeyTrackingServiceClient create(KeyTrackingServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

      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).

    • getSettings

      public final KeyTrackingServiceSettings getSettings()

    • getStub

      public KeyTrackingServiceStub getStub()

    • getProtectedResourcesSummary

      public final ProtectedResourcesSummary getProtectedResourcesSummary(ProtectedResourcesSummaryName name)
      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.

      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);
 }
      Parameters:
      name - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • getProtectedResourcesSummary

      public final ProtectedResourcesSummary getProtectedResourcesSummary(String name)
      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.

      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);
 }
      Parameters:
      name - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • getProtectedResourcesSummary

      public final ProtectedResourcesSummary getProtectedResourcesSummary(GetProtectedResourcesSummaryRequest request)
      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.

      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())
           .setFallbackScope(FallbackScope.forNumber(0))
           .build();
   ProtectedResourcesSummary response =
       keyTrackingServiceClient.getProtectedResourcesSummary(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getProtectedResourcesSummaryCallable

      public final UnaryCallable<GetProtectedResourcesSummaryRequest,ProtectedResourcesSummary> getProtectedResourcesSummaryCallable()
      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.

      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())
           .setFallbackScope(FallbackScope.forNumber(0))
           .build();
   ApiFuture<ProtectedResourcesSummary> future =
       keyTrackingServiceClient.getProtectedResourcesSummaryCallable().futureCall(request);
   // Do something.
   ProtectedResourcesSummary response = future.get();
 }

    • searchProtectedResources

      public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(OrganizationName scope, ResourceName cryptoKey)
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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:
      scope - Required. A scope can be an organization or a project. Resources protected by the crypto key in provided scope will be returned.

      The following values are allowed:

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      cryptoKey - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • searchProtectedResources

      public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(OrganizationName scope, String cryptoKey)
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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:
      scope - Required. A scope can be an organization or a project. Resources protected by the crypto key in provided scope will be returned.

      The following values are allowed:

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      cryptoKey - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • searchProtectedResources

      public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(ProjectName scope, ResourceName cryptoKey)
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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()) {
   ProjectName scope = ProjectName.of("[PROJECT]");
   ResourceName cryptoKey = OrganizationName.of("[ORGANIZATION]");
   for (ProtectedResource element :
       keyTrackingServiceClient.searchProtectedResources(scope, cryptoKey).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      scope - Required. A scope can be an organization or a project. Resources protected by the crypto key in provided scope will be returned.

      The following values are allowed:

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      cryptoKey - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • searchProtectedResources

      public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(ProjectName scope, String cryptoKey)
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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()) {
   ProjectName scope = ProjectName.of("[PROJECT]");
   String cryptoKey = OrganizationName.of("[ORGANIZATION]").toString();
   for (ProtectedResource element :
       keyTrackingServiceClient.searchProtectedResources(scope, cryptoKey).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      scope - Required. A scope can be an organization or a project. Resources protected by the crypto key in provided scope will be returned.

      The following values are allowed:

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      cryptoKey - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • searchProtectedResources

      public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(String scope, ResourceName cryptoKey)
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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:
      scope - Required. A scope can be an organization or a project. Resources protected by the crypto key in provided scope will be returned.

      The following values are allowed:

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      cryptoKey - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • searchProtectedResources

      public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(String scope, String cryptoKey)
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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:
      scope - Required. A scope can be an organization or a project. Resources protected by the crypto key in provided scope will be returned.

      The following values are allowed:

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      cryptoKey - Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
      Throws:
      ApiException - if the remote call fails

    • searchProtectedResources

      public final KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse searchProtectedResources(SearchProtectedResourcesRequest request)
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • searchProtectedResourcesPagedCallable

      public final UnaryCallable<SearchProtectedResourcesRequest,KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse> searchProtectedResourcesPagedCallable()
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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);
   }
 }

    • searchProtectedResourcesCallable

      public final UnaryCallable<SearchProtectedResourcesRequest,SearchProtectedResourcesResponse> searchProtectedResourcesCallable()
      Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization/project.

      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;
     }
   }
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException