# Class KeyTrackingServiceClient (0.82.0)

0.82.0 (latest) 0.80.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.67.0 0.65.0 0.64.0 0.63.0 0.62.0 0.61.0 0.59.0 0.57.0 0.56.0 0.53.0 0.52.0 0.51.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

|---|---|---|---|
| [GitHub Repository](https://github.com/googleapis/google-cloud-java/tree/main/java-kmsinventory/google-cloud-kmsinventory/src/main/java/com/google/cloud/kms/inventory/v1/KeyTrackingServiceClient.java) | [Product Reference](https://cloud.google.com/kms/docs/) | [REST Documentation](https://cloud.google.com/kms/docs/reference/rest) | [RPC Documentation](https://cloud.google.com/kms/docs/reference/rpc) |

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

| Method | Description | Method Variants |
|---|---|---|
| GetProtectedResourcesSummary | Returns aggregate information about the resources protected by the given Cloud KMS 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 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 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() |
[Methods]

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](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> KeyTrackingServiceClient

## Static Methods

### create()

    public static final KeyTrackingServiceClient create()

Constructs an instance of KeyTrackingServiceClient with default settings.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### 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` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceSettings` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### 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` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.stub.KeyTrackingServiceStub` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.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` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceSettings` |

### KeyTrackingServiceClient(KeyTrackingServiceStub stub)

    protected KeyTrackingServiceClient(KeyTrackingServiceStub stub)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.stub.KeyTrackingServiceStub` |

## Methods

### awaitTermination(long duration, TimeUnit unit)

    public boolean awaitTermination(long duration, TimeUnit unit)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `duration` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |
| `unit` | `https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html` |   |

### 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. 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
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);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.GetProtectedResourcesSummaryRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.ProtectedResourcesSummary` |   |

### getProtectedResourcesSummary(ProtectedResourcesSummaryName name)

    public final ProtectedResourcesSummary getProtectedResourcesSummary(ProtectedResourcesSummaryName name)

Returns aggregate information about the resources protected by the given Cloud KMS
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
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);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.ProtectedResourcesSummaryName` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.ProtectedResourcesSummary` |   |

### getProtectedResourcesSummary(String name)

    public final ProtectedResourcesSummary getProtectedResourcesSummary(String name)

Returns aggregate information about the resources protected by the given Cloud KMS
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
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);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.ProtectedResourcesSummary` |   |

### getProtectedResourcesSummaryCallable()

    public final UnaryCallable<GetProtectedResourcesSummaryRequest,ProtectedResourcesSummary> getProtectedResourcesSummaryCallable()

Returns aggregate information about the resources protected by the given Cloud KMS
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
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();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.GetProtectedResourcesSummaryRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.ProtectedResourcesSummary>` |   |

### getSettings()

    public final KeyTrackingServiceSettings getSettings()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceSettings` |   |

### getStub()

    public KeyTrackingServiceStub getStub()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.stub.KeyTrackingServiceStub` |   |

### isShutdown()

    public boolean isShutdown()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### isTerminated()

    public boolean isTerminated()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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/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** ||
|---|---|
| **Name** | **Description** |
| `scope` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.OrganizationName` 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") <br /> |
| `cryptoKey` | `com.google.api.resourcenames.ResourceName` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.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/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** ||
|---|---|
| **Name** | **Description** |
| `scope` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.OrganizationName` 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") <br /> |
| `cryptoKey` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse` |   |

### searchProtectedResources(ProjectName scope, ResourceName cryptoKey)

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

Returns metadata about the resources protected by the given Cloud KMS
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** ||
|---|---|
| **Name** | **Description** |
| `scope` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.ProjectName` 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") <br /> |
| `cryptoKey` | `com.google.api.resourcenames.ResourceName` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse` |   |

### searchProtectedResources(ProjectName scope, String cryptoKey)

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

Returns metadata about the resources protected by the given Cloud KMS
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** ||
|---|---|
| **Name** | **Description** |
| `scope` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.ProjectName` 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") <br /> |
| `cryptoKey` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.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/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);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.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/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** ||
|---|---|
| **Name** | **Description** |
| `scope` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` 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") <br /> |
| `cryptoKey` | `com.google.api.resourcenames.ResourceName` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.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/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** ||
|---|---|
| **Name** | **Description** |
| `scope` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` 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") <br /> |
| `cryptoKey` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The resource name of the CryptoKey. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.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/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;
         }
       }
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.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/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);
       }
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-kmsinventory/latest/com.google.cloud.kms.inventory.v1.KeyTrackingServiceClient.SearchProtectedResourcesPagedResponse>` |   |

### shutdown()

    public void shutdown()

### shutdownNow()

    public void shutdownNow()