java.lang.Object
- com.google.cloud.kms.inventory.v1.KeyDashboardServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated("by gapic-generator-java")
public class KeyDashboardServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`KeyDashboardServiceClient.ListCryptoKeysFixedSizeCollection`
`static class`	`KeyDashboardServiceClient.ListCryptoKeysPage`
`static class`	`KeyDashboardServiceClient.ListCryptoKeysPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`KeyDashboardServiceClient(KeyDashboardServiceSettings settings)`	Constructs an instance of KeyDashboardServiceClient, using the given settings.
`protected`	`KeyDashboardServiceClient(KeyDashboardServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static KeyDashboardServiceClient`	`create()`	Constructs an instance of KeyDashboardServiceClient with default settings.
`static KeyDashboardServiceClient`	`create(KeyDashboardServiceSettings settings)`	Constructs an instance of KeyDashboardServiceClient, using the given settings.
`static KeyDashboardServiceClient`	`create(KeyDashboardServiceStub stub)`	Constructs an instance of KeyDashboardServiceClient, using the given stub for making calls.
`KeyDashboardServiceSettings`	`getSettings()`
`KeyDashboardServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`KeyDashboardServiceClient.ListCryptoKeysPagedResponse`	`listCryptoKeys(ListCryptoKeysRequest request)`	Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
`KeyDashboardServiceClient.ListCryptoKeysPagedResponse`	`listCryptoKeys(ProjectName parent)`	Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
`KeyDashboardServiceClient.ListCryptoKeysPagedResponse`	`listCryptoKeys(String parent)`	Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
`com.google.api.gax.rpc.UnaryCallable<ListCryptoKeysRequest,ListCryptoKeysResponse>`	`listCryptoKeysCallable()`	Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
`com.google.api.gax.rpc.UnaryCallable<ListCryptoKeysRequest,KeyDashboardServiceClient.ListCryptoKeysPagedResponse>`	`listCryptoKeysPagedCallable()`	Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- KeyDashboardServiceClient
```
protected KeyDashboardServiceClient(KeyDashboardServiceSettings settings)
                             throws IOException
```
  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.
  
  Throws:
  
  IOException
- KeyDashboardServiceClient
```
protected KeyDashboardServiceClient(KeyDashboardServiceStub stub)
```

Method Detail

create

public static final KeyDashboardServiceClient create()
                                              throws IOException

Constructs an instance of KeyDashboardServiceClient with default settings.

Throws:: IOException

create
```
public static final KeyDashboardServiceClient create(KeyDashboardServiceSettings settings)
                                              throws IOException
```
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.

Throws:

IOException

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

getSettings

public final KeyDashboardServiceSettings getSettings()