Provides interfaces for using Cloud KMS
Autokey to provision new
CryptoKeys, ready for Customer Managed
Encryption Key (CMEK) use, on-demand. To support certain client tooling, this
feature is modeled around a KeyHandle
resource: creating a KeyHandle in a resource
project and given location triggers Cloud KMS Autokey to provision a
CryptoKey in the configured key project and
the same location.
Prior to use in a given resource project,
UpdateAutokeyConfig
should have been called on an ancestor folder, setting the key project where
Cloud KMS Autokey should create new
CryptoKeys. See documentation for additional
prerequisites. To check what key project, if any, is currently configured on
a resource project's ancestor folder, see
ShowEffectiveAutokeyConfig.
Creates a new KeyHandle, triggering the
provisioning of a new CryptoKey for CMEK
use with the given resource type in the configured key project and the same
location. GetOperation should
be used to resolve the resulting long-running operation and get the
resulting KeyHandle and
CryptoKey.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Interface AutokeyGrpc.AsyncService (2.75.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.75.0 (latest)](/java/docs/reference/google-cloud-kms/latest/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.73.0](/java/docs/reference/google-cloud-kms/2.73.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.71.0](/java/docs/reference/google-cloud-kms/2.71.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.70.0](/java/docs/reference/google-cloud-kms/2.70.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.67.0](/java/docs/reference/google-cloud-kms/2.67.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.66.0](/java/docs/reference/google-cloud-kms/2.66.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.65.0](/java/docs/reference/google-cloud-kms/2.65.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.63.0](/java/docs/reference/google-cloud-kms/2.63.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.62.0](/java/docs/reference/google-cloud-kms/2.62.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.61.0](/java/docs/reference/google-cloud-kms/2.61.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.60.0](/java/docs/reference/google-cloud-kms/2.60.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.59.0](/java/docs/reference/google-cloud-kms/2.59.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.58.0](/java/docs/reference/google-cloud-kms/2.58.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.57.0](/java/docs/reference/google-cloud-kms/2.57.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.56.0](/java/docs/reference/google-cloud-kms/2.56.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.55.0](/java/docs/reference/google-cloud-kms/2.55.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.54.0](/java/docs/reference/google-cloud-kms/2.54.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.52.0](/java/docs/reference/google-cloud-kms/2.52.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.51.0](/java/docs/reference/google-cloud-kms/2.51.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.50.0](/java/docs/reference/google-cloud-kms/2.50.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.49.0](/java/docs/reference/google-cloud-kms/2.49.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.48.0](/java/docs/reference/google-cloud-kms/2.48.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.47.0](/java/docs/reference/google-cloud-kms/2.47.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.46.0](/java/docs/reference/google-cloud-kms/2.46.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.45.0](/java/docs/reference/google-cloud-kms/2.45.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.44.0](/java/docs/reference/google-cloud-kms/2.44.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.43.0](/java/docs/reference/google-cloud-kms/2.43.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.42.0](/java/docs/reference/google-cloud-kms/2.42.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.40.0](/java/docs/reference/google-cloud-kms/2.40.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.39.0](/java/docs/reference/google-cloud-kms/2.39.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.38.0](/java/docs/reference/google-cloud-kms/2.38.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.37.0](/java/docs/reference/google-cloud-kms/2.37.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.36.0](/java/docs/reference/google-cloud-kms/2.36.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.35.0](/java/docs/reference/google-cloud-kms/2.35.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.34.0](/java/docs/reference/google-cloud-kms/2.34.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.33.0](/java/docs/reference/google-cloud-kms/2.33.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.32.0](/java/docs/reference/google-cloud-kms/2.32.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.31.0](/java/docs/reference/google-cloud-kms/2.31.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.30.0](/java/docs/reference/google-cloud-kms/2.30.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.27.0](/java/docs/reference/google-cloud-kms/2.27.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.26.0](/java/docs/reference/google-cloud-kms/2.26.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.25.0](/java/docs/reference/google-cloud-kms/2.25.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.24.0](/java/docs/reference/google-cloud-kms/2.24.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.23.0](/java/docs/reference/google-cloud-kms/2.23.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.22.0](/java/docs/reference/google-cloud-kms/2.22.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.21.0](/java/docs/reference/google-cloud-kms/2.21.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.20.0](/java/docs/reference/google-cloud-kms/2.20.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.19.0](/java/docs/reference/google-cloud-kms/2.19.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.18.0](/java/docs/reference/google-cloud-kms/2.18.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.17.0](/java/docs/reference/google-cloud-kms/2.17.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.16.0](/java/docs/reference/google-cloud-kms/2.16.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.15.0](/java/docs/reference/google-cloud-kms/2.15.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.14.0](/java/docs/reference/google-cloud-kms/2.14.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.12.0](/java/docs/reference/google-cloud-kms/2.12.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.11.0](/java/docs/reference/google-cloud-kms/2.11.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.10.0](/java/docs/reference/google-cloud-kms/2.10.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.9.0](/java/docs/reference/google-cloud-kms/2.9.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.8.0](/java/docs/reference/google-cloud-kms/2.8.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.7.0](/java/docs/reference/google-cloud-kms/2.7.0/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.6.8](/java/docs/reference/google-cloud-kms/2.6.8/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.5.3](/java/docs/reference/google-cloud-kms/2.5.3/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.4.4](/java/docs/reference/google-cloud-kms/2.4.4/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService)\n- [2.3.1](/java/docs/reference/google-cloud-kms/2.3.1/com.google.cloud.kms.v1.AutokeyGrpc.AsyncService) \n\n public static interface AutokeyGrpc.AsyncService\n\nProvides interfaces for using [Cloud KMS\nAutokey](https://cloud.google.com/kms/help/autokey) to provision new\nCryptoKeys, ready for Customer Managed\nEncryption Key (CMEK) use, on-demand. To support certain client tooling, this\nfeature is modeled around a KeyHandle\nresource: creating a KeyHandle in a resource\nproject and given location triggers Cloud KMS Autokey to provision a\nCryptoKey in the configured key project and\nthe same location.\nPrior to use in a given resource project,\nUpdateAutokeyConfig\nshould have been called on an ancestor folder, setting the key project where\nCloud KMS Autokey should create new\nCryptoKeys. See documentation for additional\nprerequisites. To check what key project, if any, is currently configured on\na resource project's ancestor folder, see\nShowEffectiveAutokeyConfig.\n\nMethods\n-------\n\n### createKeyHandle(CreateKeyHandleRequest request, StreamObserver\\\u003cOperation\\\u003e responseObserver)\n\n public default void createKeyHandle(CreateKeyHandleRequest request, StreamObserver\u003cOperation\u003e responseObserver)\n\nCreates a new KeyHandle, triggering the\nprovisioning of a new CryptoKey for CMEK\nuse with the given resource type in the configured key project and the same\nlocation. GetOperation should\nbe used to resolve the resulting long-running operation and get the\nresulting KeyHandle and\nCryptoKey.\n\n### getKeyHandle(GetKeyHandleRequest request, StreamObserver\\\u003cKeyHandle\\\u003e responseObserver)\n\n public default void getKeyHandle(GetKeyHandleRequest request, StreamObserver\u003cKeyHandle\u003e responseObserver)\n\nReturns the KeyHandle.\n\n### listKeyHandles(ListKeyHandlesRequest request, StreamObserver\\\u003cListKeyHandlesResponse\\\u003e responseObserver)\n\n public default void listKeyHandles(ListKeyHandlesRequest request, StreamObserver\u003cListKeyHandlesResponse\u003e responseObserver)\n\nLists KeyHandles."]]