EkmServiceClient (Google Cloud KMS Parent 2.6.8 API)

java.lang.Object
- com.google.cloud.kms.v1.EkmServiceClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class EkmServiceClient
extends Object
implements BackgroundResource

Service Description: Google Cloud Key Management EKM Service

Manages external cryptographic keys and operations using those keys. Implements a REST model with the following objects:

[EkmConnection][google.cloud.kms.v1.EkmConnection]

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 (EkmServiceClient ekmServiceClient = EkmServiceClient.create()) {
   EkmConnectionName name = EkmConnectionName.of("[PROJECT]", "[LOCATION]", "[EKM_CONNECTION]");
   EkmConnection response = ekmServiceClient.getEkmConnection(name);
 }

Note: close() needs to be called on the EkmServiceClient 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 EkmServiceSettings 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
 EkmServiceSettings ekmServiceSettings =
     EkmServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EkmServiceClient ekmServiceClient = EkmServiceClient.create(ekmServiceSettings);

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
 EkmServiceSettings ekmServiceSettings =
     EkmServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EkmServiceClient ekmServiceClient = EkmServiceClient.create(ekmServiceSettings);

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
 EkmServiceSettings ekmServiceSettings =
     EkmServiceSettings.newBuilder()
         .setTransportChannelProvider(
             EkmServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 EkmServiceClient ekmServiceClient = EkmServiceClient.create(ekmServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EkmServiceClient.ListEkmConnectionsFixedSizeCollection`
`static class`	`EkmServiceClient.ListEkmConnectionsPage`
`static class`	`EkmServiceClient.ListEkmConnectionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`EkmServiceClient(EkmServiceSettings settings)` Constructs an instance of EkmServiceClient, using the given settings.
`protected`	`EkmServiceClient(EkmServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static EkmServiceClient`	`create()` Constructs an instance of EkmServiceClient with default settings.
`static EkmServiceClient`	`create(EkmServiceSettings settings)` Constructs an instance of EkmServiceClient, using the given settings.
`static EkmServiceClient`	`create(EkmServiceStub stub)` Constructs an instance of EkmServiceClient, using the given stub for making calls.
`EkmConnection`	`createEkmConnection(CreateEkmConnectionRequest request)` Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.
`EkmConnection`	`createEkmConnection(LocationName parent, String ekmConnectionId, EkmConnection ekmConnection)` Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.
`EkmConnection`	`createEkmConnection(String parent, String ekmConnectionId, EkmConnection ekmConnection)` Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.
`UnaryCallable<CreateEkmConnectionRequest,EkmConnection>`	`createEkmConnectionCallable()` Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.
`EkmConnection`	`getEkmConnection(EkmConnectionName name)` Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].
`EkmConnection`	`getEkmConnection(GetEkmConnectionRequest request)` Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].
`EkmConnection`	`getEkmConnection(String name)` Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].
`UnaryCallable<GetEkmConnectionRequest,EkmConnection>`	`getEkmConnectionCallable()` Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`EkmServiceSettings`	`getSettings()`
`EkmServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`EkmServiceClient.ListEkmConnectionsPagedResponse`	`listEkmConnections(ListEkmConnectionsRequest request)` Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
`EkmServiceClient.ListEkmConnectionsPagedResponse`	`listEkmConnections(LocationName parent)` Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
`EkmServiceClient.ListEkmConnectionsPagedResponse`	`listEkmConnections(String parent)` Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
`UnaryCallable<ListEkmConnectionsRequest,ListEkmConnectionsResponse>`	`listEkmConnectionsCallable()` Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
`UnaryCallable<ListEkmConnectionsRequest,EkmServiceClient.ListEkmConnectionsPagedResponse>`	`listEkmConnectionsPagedCallable()` Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`EkmConnection`	`updateEkmConnection(EkmConnection ekmConnection, FieldMask updateMask)` Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.
`EkmConnection`	`updateEkmConnection(UpdateEkmConnectionRequest request)` Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.
`UnaryCallable<UpdateEkmConnectionRequest,EkmConnection>`	`updateEkmConnectionCallable()` Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.

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

Constructor Detail
- EkmServiceClient
```
protected EkmServiceClient(EkmServiceSettings settings)
                    throws IOException
```
  Constructs an instance of EkmServiceClient, 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
- EkmServiceClient
```
protected EkmServiceClient(EkmServiceStub stub)
```

Method Detail

create

public static final EkmServiceClient create()
                                     throws IOException

Constructs an instance of EkmServiceClient with default settings.

Throws:: IOException

create
```
public static final EkmServiceClient create(EkmServiceSettings settings)
                                     throws IOException
```
Constructs an instance of EkmServiceClient, 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 EkmServiceClient create(EkmServiceStub stub)
```
Constructs an instance of EkmServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(EkmServiceSettings).

getSettings

public final EkmServiceSettings getSettings()

getStub
```
public EkmServiceStub getStub()
```