Class EkmServiceGrpc.EkmServiceStub (2.61.0)

public static final class EkmServiceGrpc.EkmServiceStub extends AbstractAsyncStub<EkmServiceGrpc.EkmServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > EkmServiceGrpc.EkmServiceStub
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()

Methods

build(Channel channel, CallOptions callOptions)

protected EkmServiceGrpc.EkmServiceStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
EkmServiceGrpc.EkmServiceStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEkmConnection(CreateEkmConnectionRequest request, StreamObserver<EkmConnection> responseObserver)

public void createEkmConnection(CreateEkmConnectionRequest request, StreamObserver<EkmConnection> responseObserver)

Creates a new EkmConnection in a given Project and Location.

Parameters
Name Description
request CreateEkmConnectionRequest
responseObserver io.grpc.stub.StreamObserver<EkmConnection>

getEkmConfig(GetEkmConfigRequest request, StreamObserver<EkmConfig> responseObserver)

public void getEkmConfig(GetEkmConfigRequest request, StreamObserver<EkmConfig> responseObserver)

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

Parameters
Name Description
request GetEkmConfigRequest
responseObserver io.grpc.stub.StreamObserver<EkmConfig>

getEkmConnection(GetEkmConnectionRequest request, StreamObserver<EkmConnection> responseObserver)

public void getEkmConnection(GetEkmConnectionRequest request, StreamObserver<EkmConnection> responseObserver)

Returns metadata for a given EkmConnection.

Parameters
Name Description
request GetEkmConnectionRequest
responseObserver io.grpc.stub.StreamObserver<EkmConnection>

listEkmConnections(ListEkmConnectionsRequest request, StreamObserver<ListEkmConnectionsResponse> responseObserver)

public void listEkmConnections(ListEkmConnectionsRequest request, StreamObserver<ListEkmConnectionsResponse> responseObserver)

Lists EkmConnections.

Parameters
Name Description
request ListEkmConnectionsRequest
responseObserver io.grpc.stub.StreamObserver<ListEkmConnectionsResponse>

updateEkmConfig(UpdateEkmConfigRequest request, StreamObserver<EkmConfig> responseObserver)

public void updateEkmConfig(UpdateEkmConfigRequest request, StreamObserver<EkmConfig> responseObserver)

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

Parameters
Name Description
request UpdateEkmConfigRequest
responseObserver io.grpc.stub.StreamObserver<EkmConfig>

updateEkmConnection(UpdateEkmConnectionRequest request, StreamObserver<EkmConnection> responseObserver)

public void updateEkmConnection(UpdateEkmConnectionRequest request, StreamObserver<EkmConnection> responseObserver)

Updates an EkmConnection's metadata.

Parameters
Name Description
request UpdateEkmConnectionRequest
responseObserver io.grpc.stub.StreamObserver<EkmConnection>

verifyConnectivity(VerifyConnectivityRequest request, StreamObserver<VerifyConnectivityResponse> responseObserver)

public void verifyConnectivity(VerifyConnectivityRequest request, StreamObserver<VerifyConnectivityResponse> responseObserver)

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.

Parameters
Name Description
request VerifyConnectivityRequest
responseObserver io.grpc.stub.StreamObserver<VerifyConnectivityResponse>