Class KeyManagementServiceGrpc.KeyManagementServiceBlockingStub (2.43.0)

public static final class KeyManagementServiceGrpc.KeyManagementServiceBlockingStub extends AbstractBlockingStub<KeyManagementServiceGrpc.KeyManagementServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service KeyManagementService.

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.AbstractBlockingStub > KeyManagementServiceGrpc.KeyManagementServiceBlockingStub

Methods

asymmetricDecrypt(AsymmetricDecryptRequest request)

public AsymmetricDecryptResponse asymmetricDecrypt(AsymmetricDecryptRequest request)

Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.

Parameter
NameDescription
requestAsymmetricDecryptRequest
Returns
TypeDescription
AsymmetricDecryptResponse

asymmetricSign(AsymmetricSignRequest request)

public AsymmetricSignResponse asymmetricSign(AsymmetricSignRequest request)

Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.

Parameter
NameDescription
requestAsymmetricSignRequest
Returns
TypeDescription
AsymmetricSignResponse

build(Channel channel, CallOptions callOptions)

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

createCryptoKey(CreateCryptoKeyRequest request)

public CryptoKey createCryptoKey(CreateCryptoKeyRequest request)

Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.

Parameter
NameDescription
requestCreateCryptoKeyRequest
Returns
TypeDescription
CryptoKey

createCryptoKeyVersion(CreateCryptoKeyVersionRequest request)

public CryptoKeyVersion createCryptoKeyVersion(CreateCryptoKeyVersionRequest request)

Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.

Parameter
NameDescription
requestCreateCryptoKeyVersionRequest
Returns
TypeDescription
CryptoKeyVersion

createImportJob(CreateImportJobRequest request)

public ImportJob createImportJob(CreateImportJobRequest request)

Create a new ImportJob within a KeyRing. ImportJob.import_method is required.

Parameter
NameDescription
requestCreateImportJobRequest
Returns
TypeDescription
ImportJob

createKeyRing(CreateKeyRingRequest request)

public KeyRing createKeyRing(CreateKeyRingRequest request)

Create a new KeyRing in a given Project and Location.

Parameter
NameDescription
requestCreateKeyRingRequest
Returns
TypeDescription
KeyRing

decrypt(DecryptRequest request)

public DecryptResponse decrypt(DecryptRequest request)

Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

Parameter
NameDescription
requestDecryptRequest
Returns
TypeDescription
DecryptResponse

destroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest request)

public CryptoKeyVersion destroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest request)

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.

Parameter
NameDescription
requestDestroyCryptoKeyVersionRequest
Returns
TypeDescription
CryptoKeyVersion

encrypt(EncryptRequest request)

public EncryptResponse encrypt(EncryptRequest request)

Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

Parameter
NameDescription
requestEncryptRequest
Returns
TypeDescription
EncryptResponse

generateRandomBytes(GenerateRandomBytesRequest request)

public GenerateRandomBytesResponse generateRandomBytes(GenerateRandomBytesRequest request)

Generate random bytes using the Cloud KMS randomness source in the provided location.

Parameter
NameDescription
requestGenerateRandomBytesRequest
Returns
TypeDescription
GenerateRandomBytesResponse

getCryptoKey(GetCryptoKeyRequest request)

public CryptoKey getCryptoKey(GetCryptoKeyRequest request)

Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.

Parameter
NameDescription
requestGetCryptoKeyRequest
Returns
TypeDescription
CryptoKey

getCryptoKeyVersion(GetCryptoKeyVersionRequest request)

public CryptoKeyVersion getCryptoKeyVersion(GetCryptoKeyVersionRequest request)

Returns metadata for a given CryptoKeyVersion.

Parameter
NameDescription
requestGetCryptoKeyVersionRequest
Returns
TypeDescription
CryptoKeyVersion

getImportJob(GetImportJobRequest request)

public ImportJob getImportJob(GetImportJobRequest request)

Returns metadata for a given ImportJob.

Parameter
NameDescription
requestGetImportJobRequest
Returns
TypeDescription
ImportJob

getKeyRing(GetKeyRingRequest request)

public KeyRing getKeyRing(GetKeyRingRequest request)

Returns metadata for a given KeyRing.

Parameter
NameDescription
requestGetKeyRingRequest
Returns
TypeDescription
KeyRing

getPublicKey(GetPublicKeyRequest request)

public PublicKey getPublicKey(GetPublicKeyRequest request)

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

Parameter
NameDescription
requestGetPublicKeyRequest
Returns
TypeDescription
PublicKey

importCryptoKeyVersion(ImportCryptoKeyVersionRequest request)

public CryptoKeyVersion importCryptoKeyVersion(ImportCryptoKeyVersionRequest request)

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.

Parameter
NameDescription
requestImportCryptoKeyVersionRequest
Returns
TypeDescription
CryptoKeyVersion

listCryptoKeyVersions(ListCryptoKeyVersionsRequest request)

public ListCryptoKeyVersionsResponse listCryptoKeyVersions(ListCryptoKeyVersionsRequest request)

Lists CryptoKeyVersions.

Parameter
NameDescription
requestListCryptoKeyVersionsRequest
Returns
TypeDescription
ListCryptoKeyVersionsResponse

listCryptoKeys(ListCryptoKeysRequest request)

public ListCryptoKeysResponse listCryptoKeys(ListCryptoKeysRequest request)

Lists CryptoKeys.

Parameter
NameDescription
requestListCryptoKeysRequest
Returns
TypeDescription
ListCryptoKeysResponse

listImportJobs(ListImportJobsRequest request)

public ListImportJobsResponse listImportJobs(ListImportJobsRequest request)

Lists ImportJobs.

Parameter
NameDescription
requestListImportJobsRequest
Returns
TypeDescription
ListImportJobsResponse

listKeyRings(ListKeyRingsRequest request)

public ListKeyRingsResponse listKeyRings(ListKeyRingsRequest request)

Lists KeyRings.

Parameter
NameDescription
requestListKeyRingsRequest
Returns
TypeDescription
ListKeyRingsResponse

macSign(MacSignRequest request)

public MacSignResponse macSign(MacSignRequest request)

Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.

Parameter
NameDescription
requestMacSignRequest
Returns
TypeDescription
MacSignResponse

macVerify(MacVerifyRequest request)

public MacVerifyResponse macVerify(MacVerifyRequest request)

Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.

Parameter
NameDescription
requestMacVerifyRequest
Returns
TypeDescription
MacVerifyResponse

rawDecrypt(RawDecryptRequest request)

public RawDecryptResponse rawDecrypt(RawDecryptRequest request)

Decrypts data that was originally encrypted using a raw cryptographic mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

Parameter
NameDescription
requestRawDecryptRequest
Returns
TypeDescription
RawDecryptResponse

rawEncrypt(RawEncryptRequest request)

public RawEncryptResponse rawEncrypt(RawEncryptRequest request)

Encrypts data using portable cryptographic primitives. Most users should choose Encrypt and Decrypt rather than their raw counterparts. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

Parameter
NameDescription
requestRawEncryptRequest
Returns
TypeDescription
RawEncryptResponse

restoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest request)

public CryptoKeyVersion restoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest request)

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.

Parameter
NameDescription
requestRestoreCryptoKeyVersionRequest
Returns
TypeDescription
CryptoKeyVersion

updateCryptoKey(UpdateCryptoKeyRequest request)

public CryptoKey updateCryptoKey(UpdateCryptoKeyRequest request)

Update a CryptoKey.

Parameter
NameDescription
requestUpdateCryptoKeyRequest
Returns
TypeDescription
CryptoKey

updateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest request)

public CryptoKey updateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest request)

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.

Parameter
NameDescription
requestUpdateCryptoKeyPrimaryVersionRequest
Returns
TypeDescription
CryptoKey

updateCryptoKeyVersion(UpdateCryptoKeyVersionRequest request)

public CryptoKeyVersion updateCryptoKeyVersion(UpdateCryptoKeyVersionRequest request)

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.

Parameter
NameDescription
requestUpdateCryptoKeyVersionRequest
Returns
TypeDescription
CryptoKeyVersion