EkmServiceClient (Google Cloud KMS 2.40.0 API)

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

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

@Generated(value="by gapic-generator-java")
public class EkmServiceClient
extends Object
implements com.google.api.gax.core.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().

Methods
Method	Description	Method Variants
ListEkmConnections	Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEkmConnections(ListEkmConnectionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEkmConnections(LocationName parent) listEkmConnections(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. listEkmConnectionsPagedCallable() listEkmConnectionsCallable()
GetEkmConnection	Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEkmConnection(GetEkmConnectionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEkmConnection(EkmConnectionName name) getEkmConnection(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. getEkmConnectionCallable()
CreateEkmConnection	Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createEkmConnection(CreateEkmConnectionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createEkmConnection(LocationName parent, String ekmConnectionId, EkmConnection ekmConnection) createEkmConnection(String parent, String ekmConnectionId, EkmConnection ekmConnection) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createEkmConnectionCallable()
UpdateEkmConnection	Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateEkmConnection(UpdateEkmConnectionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateEkmConnection(EkmConnection ekmConnection, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateEkmConnectionCallable()
GetEkmConfig	Returns the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEkmConfig(GetEkmConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEkmConfig(EkmConfigName name) getEkmConfig(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. getEkmConfigCallable()
UpdateEkmConfig	Updates the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateEkmConfig(UpdateEkmConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateEkmConfig(EkmConfig ekmConfig, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateEkmConfigCallable()
VerifyConnectivity	Verifies that Cloud KMS can successfully connect to the external key manager specified by an [EkmConnection][google.cloud.kms.v1.EkmConnection]. If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. verifyConnectivity(VerifyConnectivityRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. verifyConnectivity(EkmConnectionName name) verifyConnectivity(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. verifyConnectivityCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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.newHttpJsonBuilder().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`
`static class`	`EkmServiceClient.ListLocationsFixedSizeCollection`
`static class`	`EkmServiceClient.ListLocationsPage`
`static class`	`EkmServiceClient.ListLocationsPagedResponse`

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.
`com.google.api.gax.rpc.UnaryCallable<CreateEkmConnectionRequest,EkmConnection>`	`createEkmConnectionCallable()` Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.
`EkmConfig`	`getEkmConfig(EkmConfigName name)` Returns the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.
`EkmConfig`	`getEkmConfig(GetEkmConfigRequest request)` Returns the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.
`EkmConfig`	`getEkmConfig(String name)` Returns the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.
`com.google.api.gax.rpc.UnaryCallable<GetEkmConfigRequest,EkmConfig>`	`getEkmConfigCallable()` Returns the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for 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].
`com.google.api.gax.rpc.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.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`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].
`com.google.api.gax.rpc.UnaryCallable<ListEkmConnectionsRequest,ListEkmConnectionsResponse>`	`listEkmConnectionsCallable()` Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
`com.google.api.gax.rpc.UnaryCallable<ListEkmConnectionsRequest,EkmServiceClient.ListEkmConnectionsPagedResponse>`	`listEkmConnectionsPagedCallable()` Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
`EkmServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,EkmServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.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.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`EkmConfig`	`updateEkmConfig(EkmConfig ekmConfig, com.google.protobuf.FieldMask updateMask)` Updates the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.
`EkmConfig`	`updateEkmConfig(UpdateEkmConfigRequest request)` Updates the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.
`com.google.api.gax.rpc.UnaryCallable<UpdateEkmConfigRequest,EkmConfig>`	`updateEkmConfigCallable()` Updates the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.
`EkmConnection`	`updateEkmConnection(EkmConnection ekmConnection, com.google.protobuf.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.
`com.google.api.gax.rpc.UnaryCallable<UpdateEkmConnectionRequest,EkmConnection>`	`updateEkmConnectionCallable()` Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.
`VerifyConnectivityResponse`	`verifyConnectivity(EkmConnectionName name)` Verifies that Cloud KMS can successfully connect to the external key manager specified by an [EkmConnection][google.cloud.kms.v1.EkmConnection].
`VerifyConnectivityResponse`	`verifyConnectivity(String name)` Verifies that Cloud KMS can successfully connect to the external key manager specified by an [EkmConnection][google.cloud.kms.v1.EkmConnection].
`VerifyConnectivityResponse`	`verifyConnectivity(VerifyConnectivityRequest request)` Verifies that Cloud KMS can successfully connect to the external key manager specified by an [EkmConnection][google.cloud.kms.v1.EkmConnection].
`com.google.api.gax.rpc.UnaryCallable<VerifyConnectivityRequest,VerifyConnectivityResponse>`	`verifyConnectivityCallable()` Verifies that Cloud KMS can successfully connect to the external key manager specified by an [EkmConnection][google.cloud.kms.v1.EkmConnection].

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