public static final class KeyManagementServiceGrpc.KeyManagementServiceStub extends AbstractAsyncStub<KeyManagementServiceGrpc.KeyManagementServiceStub>
Google Cloud Key Management Service
Manages cryptographic keys and operations using those keys. Implements a REST
model with the following objects:
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractAsyncStub >
KeyManagementServiceGrpc.KeyManagementServiceStub
Inherited Members
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(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.withWaitForReady()
Methods
asymmetricDecrypt(AsymmetricDecryptRequest request, StreamObserver<AsymmetricDecryptResponse> responseObserver)
public void asymmetricDecrypt(AsymmetricDecryptRequest request, StreamObserver<AsymmetricDecryptResponse> responseObserver)
Decrypts data that was encrypted with a public key retrieved from
GetPublicKey
corresponding to a CryptoKeyVersion
with CryptoKey.purpose
ASYMMETRIC_DECRYPT.
Parameters
asymmetricSign(AsymmetricSignRequest request, StreamObserver<AsymmetricSignResponse> responseObserver)
public void asymmetricSign(AsymmetricSignRequest request, StreamObserver<AsymmetricSignResponse> responseObserver)
Signs data using a CryptoKeyVersion
with CryptoKey.purpose
ASYMMETRIC_SIGN, producing a signature that can be verified with the public
key retrieved from
GetPublicKey.
Parameters
build(Channel channel, CallOptions callOptions)
protected KeyManagementServiceGrpc.KeyManagementServiceStub build(Channel channel, CallOptions callOptions)
Parameters
Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createCryptoKey(CreateCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)
public void createCryptoKey(CreateCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)
Create a new CryptoKey within a
KeyRing.
CryptoKey.purpose and
CryptoKey.version_template.algorithm
are required.
Parameters
createCryptoKeyVersion(CreateCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
public void createCryptoKeyVersion(CreateCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
Create a new CryptoKeyVersion in a
CryptoKey.
The server will assign the next sequential id. If unset,
state will be set to
ENABLED.
Parameters
createImportJob(CreateImportJobRequest request, StreamObserver<ImportJob> responseObserver)
public void createImportJob(CreateImportJobRequest request, StreamObserver<ImportJob> responseObserver)
Create a new ImportJob within a
KeyRing.
ImportJob.import_method is
required.
Parameters
createKeyRing(CreateKeyRingRequest request, StreamObserver<KeyRing> responseObserver)
public void createKeyRing(CreateKeyRingRequest request, StreamObserver<KeyRing> responseObserver)
Create a new KeyRing in a given Project and
Location.
Parameters
decrypt(DecryptRequest request, StreamObserver<DecryptResponse> responseObserver)
public void decrypt(DecryptRequest request, StreamObserver<DecryptResponse> responseObserver)
Decrypts data that was protected by
Encrypt. The
CryptoKey.purpose must be
ENCRYPT_DECRYPT.
Parameters
destroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
public void destroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
Schedule a CryptoKeyVersion for
destruction.
Upon calling this method,
CryptoKeyVersion.state will
be set to
DESTROY_SCHEDULED,
and destroy_time will
be set to the time
destroy_scheduled_duration
in the future. At that time, the
state will automatically
change to
DESTROYED,
and the key material will be irrevocably destroyed.
Before the
destroy_time is
reached,
RestoreCryptoKeyVersion
may be called to reverse the process.
Parameters
encrypt(EncryptRequest request, StreamObserver<EncryptResponse> responseObserver)
public void encrypt(EncryptRequest request, StreamObserver<EncryptResponse> responseObserver)
Encrypts data, so that it can only be recovered by a call to
Decrypt. The
CryptoKey.purpose must be
ENCRYPT_DECRYPT.
Parameters
generateRandomBytes(GenerateRandomBytesRequest request, StreamObserver<GenerateRandomBytesResponse> responseObserver)
public void generateRandomBytes(GenerateRandomBytesRequest request, StreamObserver<GenerateRandomBytesResponse> responseObserver)
Generate random bytes using the Cloud KMS randomness source in the provided
location.
Parameters
getCryptoKey(GetCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)
public void getCryptoKey(GetCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)
Returns metadata for a given CryptoKey, as
well as its primary
CryptoKeyVersion.
Parameters
getCryptoKeyVersion(GetCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
public void getCryptoKeyVersion(GetCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
Returns metadata for a given
CryptoKeyVersion.
Parameters
getImportJob(GetImportJobRequest request, StreamObserver<ImportJob> responseObserver)
public void getImportJob(GetImportJobRequest request, StreamObserver<ImportJob> responseObserver)
Returns metadata for a given ImportJob.
Parameters
getKeyRing(GetKeyRingRequest request, StreamObserver<KeyRing> responseObserver)
public void getKeyRing(GetKeyRingRequest request, StreamObserver<KeyRing> responseObserver)
Returns metadata for a given KeyRing.
Parameters
getPublicKey(GetPublicKeyRequest request, StreamObserver<PublicKey> responseObserver)
public void getPublicKey(GetPublicKeyRequest request, StreamObserver<PublicKey> responseObserver)
Returns the public key for the given
CryptoKeyVersion. The
CryptoKey.purpose must be
ASYMMETRIC_SIGN
or
ASYMMETRIC_DECRYPT.
Parameters
importCryptoKeyVersion(ImportCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
public void importCryptoKeyVersion(ImportCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
Import wrapped key material into a
CryptoKeyVersion.
All requests must specify a CryptoKey. If
a CryptoKeyVersion is additionally
specified in the request, key material will be reimported into that
version. Otherwise, a new version will be created, and will be assigned the
next sequential id within the CryptoKey.
Parameters
listCryptoKeyVersions(ListCryptoKeyVersionsRequest request, StreamObserver<ListCryptoKeyVersionsResponse> responseObserver)
public void listCryptoKeyVersions(ListCryptoKeyVersionsRequest request, StreamObserver<ListCryptoKeyVersionsResponse> responseObserver)
Parameters
listCryptoKeys(ListCryptoKeysRequest request, StreamObserver<ListCryptoKeysResponse> responseObserver)
public void listCryptoKeys(ListCryptoKeysRequest request, StreamObserver<ListCryptoKeysResponse> responseObserver)
Parameters
listImportJobs(ListImportJobsRequest request, StreamObserver<ListImportJobsResponse> responseObserver)
public void listImportJobs(ListImportJobsRequest request, StreamObserver<ListImportJobsResponse> responseObserver)
Parameters
listKeyRings(ListKeyRingsRequest request, StreamObserver<ListKeyRingsResponse> responseObserver)
public void listKeyRings(ListKeyRingsRequest request, StreamObserver<ListKeyRingsResponse> responseObserver)
Parameters
macSign(MacSignRequest request, StreamObserver<MacSignResponse> responseObserver)
public void macSign(MacSignRequest request, StreamObserver<MacSignResponse> responseObserver)
Signs data using a CryptoKeyVersion
with CryptoKey.purpose MAC,
producing a tag that can be verified by another source with the same key.
Parameters
macVerify(MacVerifyRequest request, StreamObserver<MacVerifyResponse> responseObserver)
public void macVerify(MacVerifyRequest request, StreamObserver<MacVerifyResponse> responseObserver)
Verifies MAC tag using a
CryptoKeyVersion with
CryptoKey.purpose MAC, and returns
a response that indicates whether or not the verification was successful.
Parameters
restoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
public void restoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
Restore a CryptoKeyVersion in the
DESTROY_SCHEDULED
state.
Upon restoration of the CryptoKeyVersion,
state will be set to
DISABLED,
and destroy_time will
be cleared.
Parameters
updateCryptoKey(UpdateCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)
public void updateCryptoKey(UpdateCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)
Parameters
updateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest request, StreamObserver<CryptoKey> responseObserver)
public void updateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest request, StreamObserver<CryptoKey> responseObserver)
Update the version of a CryptoKey that
will be used in
Encrypt.
Returns an error if called on a key whose purpose is not
ENCRYPT_DECRYPT.
Parameters
updateCryptoKeyVersion(UpdateCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
public void updateCryptoKeyVersion(UpdateCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)
Update a CryptoKeyVersion's
metadata.
state may be changed between
ENABLED
and
DISABLED
using this method. See
DestroyCryptoKeyVersion
and
RestoreCryptoKeyVersion
to move between other states.
Parameters