Class KeyManagementServiceGrpc.KeyManagementServiceStub (2.88.0)

public static final class KeyManagementServiceGrpc.KeyManagementServiceStub extends AbstractAsyncStub<KeyManagementServiceGrpc.KeyManagementServiceStub>

A stub to allow clients to do asynchronous 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:

KeyRing
CryptoKey
CryptoKeyVersion
ImportJob If you are using manual gRPC libraries, see Using gRPC with Cloud KMS.

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(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()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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
Name	Description
`request`	`AsymmetricDecryptRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<AsymmetricDecryptResponse>`

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
Name	Description
`request`	`AsymmetricSignRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<AsymmetricSignResponse>`

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
Type	Description
`KeyManagementServiceGrpc.KeyManagementServiceStub`

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
Name	Description
`request`	`CreateCryptoKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKey>`

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
Name	Description
`request`	`CreateCryptoKeyVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKeyVersion>`

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
Name	Description
`request`	`CreateImportJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ImportJob>`

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
Name	Description
`request`	`CreateKeyRingRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<KeyRing>`

decapsulate(DecapsulateRequest request, StreamObserver<DecapsulateResponse> responseObserver)

public void decapsulate(DecapsulateRequest request, StreamObserver<DecapsulateResponse> responseObserver)

Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.

Parameters
Name	Description
`request`	`DecapsulateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<DecapsulateResponse>`

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
Name	Description
`request`	`DecryptRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<DecryptResponse>`

deleteCryptoKey(DeleteCryptoKeyRequest request, StreamObserver<Operation> responseObserver)

public void deleteCryptoKey(DeleteCryptoKeyRequest request, StreamObserver<Operation> responseObserver)

Permanently deletes the given CryptoKey. All child CryptoKeyVersions must have been previously deleted using KeyManagementService.DeleteCryptoKeyVersion. The specified crypto key will be immediately and permanently deleted upon calling this method. This action cannot be undone.

Parameters
Name	Description
`request`	`DeleteCryptoKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteCryptoKeyVersion(DeleteCryptoKeyVersionRequest request, StreamObserver<Operation> responseObserver)

public void deleteCryptoKeyVersion(DeleteCryptoKeyVersionRequest request, StreamObserver<Operation> responseObserver)

Permanently deletes the given CryptoKeyVersion. Only possible if the version has not been previously imported and if its state is one of DESTROYED, IMPORT_FAILED, or GENERATION_FAILED. Successfully imported CryptoKeyVersions cannot be deleted at this time. The specified version will be immediately and permanently deleted upon calling this method. This action cannot be undone.

Parameters
Name	Description
`request`	`DeleteCryptoKeyVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

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
Name	Description
`request`	`DestroyCryptoKeyVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKeyVersion>`

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
Name	Description
`request`	`EncryptRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<EncryptResponse>`

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
Name	Description
`request`	`GenerateRandomBytesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<GenerateRandomBytesResponse>`

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
Name	Description
`request`	`GetCryptoKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKey>`

getCryptoKeyVersion(GetCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)

public void getCryptoKeyVersion(GetCryptoKeyVersionRequest request, StreamObserver<CryptoKeyVersion> responseObserver)

Returns metadata for a given CryptoKeyVersion.

Parameters
Name	Description
`request`	`GetCryptoKeyVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKeyVersion>`

getImportJob(GetImportJobRequest request, StreamObserver<ImportJob> responseObserver)

public void getImportJob(GetImportJobRequest request, StreamObserver<ImportJob> responseObserver)

Returns metadata for a given ImportJob.

Parameters
Name	Description
`request`	`GetImportJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ImportJob>`

getKeyRing(GetKeyRingRequest request, StreamObserver<KeyRing> responseObserver)

public void getKeyRing(GetKeyRingRequest request, StreamObserver<KeyRing> responseObserver)

Returns metadata for a given KeyRing.

Parameters
Name	Description
`request`	`GetKeyRingRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<KeyRing>`

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
Name	Description
`request`	`GetPublicKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<PublicKey>`

getRetiredResource(GetRetiredResourceRequest request, StreamObserver<RetiredResource> responseObserver)

public void getRetiredResource(GetRetiredResourceRequest request, StreamObserver<RetiredResource> responseObserver)

Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey.

Parameters
Name	Description
`request`	`GetRetiredResourceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<RetiredResource>`

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
Name	Description
`request`	`ImportCryptoKeyVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKeyVersion>`

listCryptoKeyVersions(ListCryptoKeyVersionsRequest request, StreamObserver<ListCryptoKeyVersionsResponse> responseObserver)

public void listCryptoKeyVersions(ListCryptoKeyVersionsRequest request, StreamObserver<ListCryptoKeyVersionsResponse> responseObserver)

Lists CryptoKeyVersions.

Parameters
Name	Description
`request`	`ListCryptoKeyVersionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListCryptoKeyVersionsResponse>`

listCryptoKeys(ListCryptoKeysRequest request, StreamObserver<ListCryptoKeysResponse> responseObserver)

public void listCryptoKeys(ListCryptoKeysRequest request, StreamObserver<ListCryptoKeysResponse> responseObserver)

Lists CryptoKeys.

Parameters
Name	Description
`request`	`ListCryptoKeysRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListCryptoKeysResponse>`

listImportJobs(ListImportJobsRequest request, StreamObserver<ListImportJobsResponse> responseObserver)

public void listImportJobs(ListImportJobsRequest request, StreamObserver<ListImportJobsResponse> responseObserver)

Lists ImportJobs.

Parameters
Name	Description
`request`	`ListImportJobsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListImportJobsResponse>`

listKeyRings(ListKeyRingsRequest request, StreamObserver<ListKeyRingsResponse> responseObserver)

public void listKeyRings(ListKeyRingsRequest request, StreamObserver<ListKeyRingsResponse> responseObserver)

Lists KeyRings.

Parameters
Name	Description
`request`	`ListKeyRingsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListKeyRingsResponse>`

listRetiredResources(ListRetiredResourcesRequest request, StreamObserver<ListRetiredResourcesResponse> responseObserver)

public void listRetiredResources(ListRetiredResourcesRequest request, StreamObserver<ListRetiredResourcesResponse> responseObserver)

Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion.

Parameters
Name	Description
`request`	`ListRetiredResourcesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListRetiredResourcesResponse>`

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
Name	Description
`request`	`MacSignRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<MacSignResponse>`

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
Name	Description
`request`	`MacVerifyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<MacVerifyResponse>`

rawDecrypt(RawDecryptRequest request, StreamObserver<RawDecryptResponse> responseObserver)

public void rawDecrypt(RawDecryptRequest request, StreamObserver<RawDecryptResponse> responseObserver)

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

Parameters
Name	Description
`request`	`RawDecryptRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<RawDecryptResponse>`

rawEncrypt(RawEncryptRequest request, StreamObserver<RawEncryptResponse> responseObserver)

public void rawEncrypt(RawEncryptRequest request, StreamObserver<RawEncryptResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`RawEncryptRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<RawEncryptResponse>`

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
Name	Description
`request`	`RestoreCryptoKeyVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKeyVersion>`

updateCryptoKey(UpdateCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)

public void updateCryptoKey(UpdateCryptoKeyRequest request, StreamObserver<CryptoKey> responseObserver)

Update a CryptoKey.

Parameters
Name	Description
`request`	`UpdateCryptoKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKey>`

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
Name	Description
`request`	`UpdateCryptoKeyPrimaryVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKey>`

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
Name	Description
`request`	`UpdateCryptoKeyVersionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<CryptoKeyVersion>`

Class KeyManagementServiceGrpc.KeyManagementServiceStub (2.88.0) Stay organized with collections Save and categorize content based on your preferences.