Class EkmServiceGrpc.EkmServiceBlockingV2Stub (2.83.0)

public static final class EkmServiceGrpc.EkmServiceBlockingV2Stub extends AbstractBlockingStub<EkmServiceGrpc.EkmServiceBlockingV2Stub>

A stub to allow clients to do synchronous 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.AbstractBlockingStub > EkmServiceGrpc.EkmServiceBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

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

createEkmConnection(CreateEkmConnectionRequest request)

public EkmConnection createEkmConnection(CreateEkmConnectionRequest request)

Creates a new EkmConnection in a given Project and Location.

Parameter
Name Description
request CreateEkmConnectionRequest
Returns
Type Description
EkmConnection
Exceptions
Type Description
io.grpc.StatusException

getEkmConfig(GetEkmConfigRequest request)

public EkmConfig getEkmConfig(GetEkmConfigRequest request)

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

Parameter
Name Description
request GetEkmConfigRequest
Returns
Type Description
EkmConfig
Exceptions
Type Description
io.grpc.StatusException

getEkmConnection(GetEkmConnectionRequest request)

public EkmConnection getEkmConnection(GetEkmConnectionRequest request)

Returns metadata for a given EkmConnection.

Parameter
Name Description
request GetEkmConnectionRequest
Returns
Type Description
EkmConnection
Exceptions
Type Description
io.grpc.StatusException

listEkmConnections(ListEkmConnectionsRequest request)

public ListEkmConnectionsResponse listEkmConnections(ListEkmConnectionsRequest request)

Lists EkmConnections.

Parameter
Name Description
request ListEkmConnectionsRequest
Returns
Type Description
ListEkmConnectionsResponse
Exceptions
Type Description
io.grpc.StatusException

updateEkmConfig(UpdateEkmConfigRequest request)

public EkmConfig updateEkmConfig(UpdateEkmConfigRequest request)

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

Parameter
Name Description
request UpdateEkmConfigRequest
Returns
Type Description
EkmConfig
Exceptions
Type Description
io.grpc.StatusException

updateEkmConnection(UpdateEkmConnectionRequest request)

public EkmConnection updateEkmConnection(UpdateEkmConnectionRequest request)

Updates an EkmConnection's metadata.

Parameter
Name Description
request UpdateEkmConnectionRequest
Returns
Type Description
EkmConnection
Exceptions
Type Description
io.grpc.StatusException

verifyConnectivity(VerifyConnectivityRequest request)

public 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
Name Description
request VerifyConnectivityRequest
Returns
Type Description
VerifyConnectivityResponse
Exceptions
Type Description
io.grpc.StatusException