Class EkmServiceGrpc.EkmServiceFutureStub (2.21.0)

public static final class EkmServiceGrpc.EkmServiceFutureStub extends AbstractFutureStub<EkmServiceGrpc.EkmServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service EkmService.

Google Cloud Key Management EKM Service Manages external cryptographic keys and operations using those keys. Implements a REST model with the following objects:

  • EkmConnection

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > EkmServiceGrpc.EkmServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected EkmServiceGrpc.EkmServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
EkmServiceGrpc.EkmServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEkmConnection(CreateEkmConnectionRequest request)

public ListenableFuture<EkmConnection> createEkmConnection(CreateEkmConnectionRequest request)

Creates a new EkmConnection in a given Project and Location.

Parameter
NameDescription
requestCreateEkmConnectionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EkmConnection>

getEkmConfig(GetEkmConfigRequest request)

public ListenableFuture<EkmConfig> getEkmConfig(GetEkmConfigRequest request)

Returns the EkmConfig singleton resource for a given project and location.

Parameter
NameDescription
requestGetEkmConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EkmConfig>

getEkmConnection(GetEkmConnectionRequest request)

public ListenableFuture<EkmConnection> getEkmConnection(GetEkmConnectionRequest request)

Returns metadata for a given EkmConnection.

Parameter
NameDescription
requestGetEkmConnectionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EkmConnection>

listEkmConnections(ListEkmConnectionsRequest request)

public ListenableFuture<ListEkmConnectionsResponse> listEkmConnections(ListEkmConnectionsRequest request)

Lists EkmConnections.

Parameter
NameDescription
requestListEkmConnectionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListEkmConnectionsResponse>

updateEkmConfig(UpdateEkmConfigRequest request)

public ListenableFuture<EkmConfig> updateEkmConfig(UpdateEkmConfigRequest request)

Updates the EkmConfig singleton resource for a given project and location.

Parameter
NameDescription
requestUpdateEkmConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EkmConfig>

updateEkmConnection(UpdateEkmConnectionRequest request)

public ListenableFuture<EkmConnection> updateEkmConnection(UpdateEkmConnectionRequest request)

Updates an EkmConnection's metadata.

Parameter
NameDescription
requestUpdateEkmConnectionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EkmConnection>

verifyConnectivity(VerifyConnectivityRequest request)

public ListenableFuture<VerifyConnectivityResponse> verifyConnectivity(VerifyConnectivityRequest request)

Verifies that Cloud KMS can successfully connect to the external key manager specified by an 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.

Parameter
NameDescription
requestVerifyConnectivityRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<VerifyConnectivityResponse>