Class KeyDashboardServiceClient (0.36.0)

Service Description: Provides a cross-region view of all Cloud KMS keys in a given Cloud project.

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 (KeyDashboardServiceClient keyDashboardServiceClient = KeyDashboardServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (CryptoKey element : keyDashboardServiceClient.listCryptoKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the KeyDashboardServiceClient 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
ListCryptoKeys	Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCryptoKeys(ListCryptoKeysRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCryptoKeys(ProjectName parent) listCryptoKeys(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCryptoKeysPagedCallable() listCryptoKeysCallable()

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 KeyDashboardServiceSettings 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
 KeyDashboardServiceSettings keyDashboardServiceSettings =
     KeyDashboardServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeyDashboardServiceClient keyDashboardServiceClient =
     KeyDashboardServiceClient.create(keyDashboardServiceSettings);

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
 KeyDashboardServiceSettings keyDashboardServiceSettings =
     KeyDashboardServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeyDashboardServiceClient keyDashboardServiceClient =
     KeyDashboardServiceClient.create(keyDashboardServiceSettings);

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
 KeyDashboardServiceSettings keyDashboardServiceSettings =
     KeyDashboardServiceSettings.newHttpJsonBuilder().build();
 KeyDashboardServiceClient keyDashboardServiceClient =
     KeyDashboardServiceClient.create(keyDashboardServiceSettings);

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

Inheritance

java.lang.Object > KeyDashboardServiceClient

Static Methods

create()

public static final KeyDashboardServiceClient create()

Constructs an instance of KeyDashboardServiceClient with default settings.

Returns
Type	Description
`KeyDashboardServiceClient`

Exceptions
Type	Description
`IOException`

create(KeyDashboardServiceSettings settings)

public static final KeyDashboardServiceClient create(KeyDashboardServiceSettings settings)

Constructs an instance of KeyDashboardServiceClient, 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`	`KeyDashboardServiceSettings`

Returns
Type	Description
`KeyDashboardServiceClient`

Exceptions
Type	Description
`IOException`

create(KeyDashboardServiceStub stub)

public static final KeyDashboardServiceClient create(KeyDashboardServiceStub stub)

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

Parameter
Name	Description
`stub`	`KeyDashboardServiceStub`

Returns
Type	Description
`KeyDashboardServiceClient`

Constructors

KeyDashboardServiceClient(KeyDashboardServiceSettings settings)

protected KeyDashboardServiceClient(KeyDashboardServiceSettings settings)

Constructs an instance of KeyDashboardServiceClient, 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`	`KeyDashboardServiceSettings`

KeyDashboardServiceClient(KeyDashboardServiceStub stub)

protected KeyDashboardServiceClient(KeyDashboardServiceStub stub)

Parameter
Name	Description
`stub`	`KeyDashboardServiceStub`

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

getSettings()

public final KeyDashboardServiceSettings getSettings()

Returns
Type	Description
`KeyDashboardServiceSettings`

getStub()

public KeyDashboardServiceStub getStub()

Returns
Type	Description
`KeyDashboardServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCryptoKeys(ListCryptoKeysRequest request)

public final KeyDashboardServiceClient.ListCryptoKeysPagedResponse listCryptoKeys(ListCryptoKeysRequest request)

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

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 (KeyDashboardServiceClient keyDashboardServiceClient = KeyDashboardServiceClient.create()) {
   ListCryptoKeysRequest request =
       ListCryptoKeysRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CryptoKey element : keyDashboardServiceClient.listCryptoKeys(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListCryptoKeysRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`KeyDashboardServiceClient.ListCryptoKeysPagedResponse`

listCryptoKeys(ProjectName parent)

public final KeyDashboardServiceClient.ListCryptoKeysPagedResponse listCryptoKeys(ProjectName parent)

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 (KeyDashboardServiceClient keyDashboardServiceClient = KeyDashboardServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (CryptoKey element : keyDashboardServiceClient.listCryptoKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`ProjectName` Required. The Google Cloud project for which to retrieve key metadata, in the format `projects/*`

Returns
Type	Description
`KeyDashboardServiceClient.ListCryptoKeysPagedResponse`

listCryptoKeys(String parent)

public final KeyDashboardServiceClient.ListCryptoKeysPagedResponse listCryptoKeys(String parent)

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 (KeyDashboardServiceClient keyDashboardServiceClient = KeyDashboardServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (CryptoKey element : keyDashboardServiceClient.listCryptoKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The Google Cloud project for which to retrieve key metadata, in the format `projects/*`

Returns
Type	Description
`KeyDashboardServiceClient.ListCryptoKeysPagedResponse`

listCryptoKeysCallable()

public final UnaryCallable<ListCryptoKeysRequest,ListCryptoKeysResponse> listCryptoKeysCallable()

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 (KeyDashboardServiceClient keyDashboardServiceClient = KeyDashboardServiceClient.create()) {
   ListCryptoKeysRequest request =
       ListCryptoKeysRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCryptoKeysResponse response =
         keyDashboardServiceClient.listCryptoKeysCallable().call(request);
     for (CryptoKey element : response.getCryptoKeysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCryptoKeysRequest,ListCryptoKeysResponse>`

listCryptoKeysPagedCallable()

public final UnaryCallable<ListCryptoKeysRequest,KeyDashboardServiceClient.ListCryptoKeysPagedResponse> listCryptoKeysPagedCallable()

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 (KeyDashboardServiceClient keyDashboardServiceClient = KeyDashboardServiceClient.create()) {
   ListCryptoKeysRequest request =
       ListCryptoKeysRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CryptoKey> future =
       keyDashboardServiceClient.listCryptoKeysPagedCallable().futureCall(request);
   // Do something.
   for (CryptoKey element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListCryptoKeysRequest,ListCryptoKeysPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()