Output only. Name of a CryptoKey that has
been provisioned for Customer Managed Encryption Key (CMEK) use in the
KeyHandle project and location for the
requested resource type. The CryptoKey
project will reflect the value configured in the
AutokeyConfig on the resource
project's ancestor folder at the time of the
KeyHandle creation. If more than one
ancestor folder has a configured
AutokeyConfig, the nearest of these
configurations is used.
Output only. Name of a CryptoKey that has
been provisioned for Customer Managed Encryption Key (CMEK) use in the
KeyHandle project and location for the
requested resource type. The CryptoKey
project will reflect the value configured in the
AutokeyConfig on the resource
project's ancestor folder at the time of the
KeyHandle creation. If more than one
ancestor folder has a configured
AutokeyConfig, the nearest of these
configurations is used.
Required. Indicates the resource type that the resulting
CryptoKey is meant to protect, e.g.
{SERVICE}.googleapis.com/{TYPE}. See documentation for supported resource
types.
Required. Indicates the resource type that the resulting
CryptoKey is meant to protect, e.g.
{SERVICE}.googleapis.com/{TYPE}. See documentation for supported resource
types.
[[["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 KeyHandleOrBuilder (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.KeyHandleOrBuilder)\n- [2.73.0](/java/docs/reference/google-cloud-kms/2.73.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.71.0](/java/docs/reference/google-cloud-kms/2.71.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.70.0](/java/docs/reference/google-cloud-kms/2.70.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.67.0](/java/docs/reference/google-cloud-kms/2.67.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.66.0](/java/docs/reference/google-cloud-kms/2.66.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.65.0](/java/docs/reference/google-cloud-kms/2.65.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.63.0](/java/docs/reference/google-cloud-kms/2.63.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.62.0](/java/docs/reference/google-cloud-kms/2.62.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.61.0](/java/docs/reference/google-cloud-kms/2.61.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.60.0](/java/docs/reference/google-cloud-kms/2.60.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.59.0](/java/docs/reference/google-cloud-kms/2.59.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.58.0](/java/docs/reference/google-cloud-kms/2.58.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.57.0](/java/docs/reference/google-cloud-kms/2.57.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.56.0](/java/docs/reference/google-cloud-kms/2.56.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.55.0](/java/docs/reference/google-cloud-kms/2.55.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.54.0](/java/docs/reference/google-cloud-kms/2.54.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.52.0](/java/docs/reference/google-cloud-kms/2.52.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.51.0](/java/docs/reference/google-cloud-kms/2.51.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.50.0](/java/docs/reference/google-cloud-kms/2.50.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.49.0](/java/docs/reference/google-cloud-kms/2.49.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.48.0](/java/docs/reference/google-cloud-kms/2.48.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.47.0](/java/docs/reference/google-cloud-kms/2.47.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.46.0](/java/docs/reference/google-cloud-kms/2.46.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.45.0](/java/docs/reference/google-cloud-kms/2.45.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.44.0](/java/docs/reference/google-cloud-kms/2.44.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.43.0](/java/docs/reference/google-cloud-kms/2.43.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.42.0](/java/docs/reference/google-cloud-kms/2.42.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.40.0](/java/docs/reference/google-cloud-kms/2.40.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.39.0](/java/docs/reference/google-cloud-kms/2.39.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.38.0](/java/docs/reference/google-cloud-kms/2.38.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.37.0](/java/docs/reference/google-cloud-kms/2.37.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.36.0](/java/docs/reference/google-cloud-kms/2.36.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.35.0](/java/docs/reference/google-cloud-kms/2.35.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.34.0](/java/docs/reference/google-cloud-kms/2.34.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.33.0](/java/docs/reference/google-cloud-kms/2.33.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.32.0](/java/docs/reference/google-cloud-kms/2.32.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.31.0](/java/docs/reference/google-cloud-kms/2.31.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.30.0](/java/docs/reference/google-cloud-kms/2.30.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.27.0](/java/docs/reference/google-cloud-kms/2.27.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.26.0](/java/docs/reference/google-cloud-kms/2.26.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.25.0](/java/docs/reference/google-cloud-kms/2.25.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.24.0](/java/docs/reference/google-cloud-kms/2.24.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.23.0](/java/docs/reference/google-cloud-kms/2.23.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.22.0](/java/docs/reference/google-cloud-kms/2.22.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.21.0](/java/docs/reference/google-cloud-kms/2.21.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.20.0](/java/docs/reference/google-cloud-kms/2.20.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.19.0](/java/docs/reference/google-cloud-kms/2.19.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.18.0](/java/docs/reference/google-cloud-kms/2.18.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.17.0](/java/docs/reference/google-cloud-kms/2.17.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.16.0](/java/docs/reference/google-cloud-kms/2.16.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.15.0](/java/docs/reference/google-cloud-kms/2.15.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.14.0](/java/docs/reference/google-cloud-kms/2.14.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.12.0](/java/docs/reference/google-cloud-kms/2.12.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.11.0](/java/docs/reference/google-cloud-kms/2.11.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.10.0](/java/docs/reference/google-cloud-kms/2.10.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.9.0](/java/docs/reference/google-cloud-kms/2.9.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.8.0](/java/docs/reference/google-cloud-kms/2.8.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.7.0](/java/docs/reference/google-cloud-kms/2.7.0/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.6.8](/java/docs/reference/google-cloud-kms/2.6.8/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.5.3](/java/docs/reference/google-cloud-kms/2.5.3/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.4.4](/java/docs/reference/google-cloud-kms/2.4.4/com.google.cloud.kms.v1.KeyHandleOrBuilder)\n- [2.3.1](/java/docs/reference/google-cloud-kms/2.3.1/com.google.cloud.kms.v1.KeyHandleOrBuilder) \n\n public interface KeyHandleOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getKmsKey()\n\n public abstract String getKmsKey()\n\nOutput only. Name of a CryptoKey that has\nbeen provisioned for Customer Managed Encryption Key (CMEK) use in the\nKeyHandle project and location for the\nrequested resource type. The CryptoKey\nproject will reflect the value configured in the\nAutokeyConfig on the resource\nproject's ancestor folder at the time of the\nKeyHandle creation. If more than one\nancestor folder has a configured\nAutokeyConfig, the nearest of these\nconfigurations is used.\n\n`\nstring kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }\n`\n\n### getKmsKeyBytes()\n\n public abstract ByteString getKmsKeyBytes()\n\nOutput only. Name of a CryptoKey that has\nbeen provisioned for Customer Managed Encryption Key (CMEK) use in the\nKeyHandle project and location for the\nrequested resource type. The CryptoKey\nproject will reflect the value configured in the\nAutokeyConfig on the resource\nproject's ancestor folder at the time of the\nKeyHandle creation. If more than one\nancestor folder has a configured\nAutokeyConfig, the nearest of these\nconfigurations is used.\n\n`\nstring kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }\n`\n\n### getName()\n\n public abstract String getName()\n\nIdentifier. Name of the KeyHandle\nresource, e.g.\n`projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.\n\n`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];`\n\n### getNameBytes()\n\n public abstract ByteString getNameBytes()\n\nIdentifier. Name of the KeyHandle\nresource, e.g.\n`projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.\n\n`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];`\n\n### getResourceTypeSelector()\n\n public abstract String getResourceTypeSelector()\n\nRequired. Indicates the resource type that the resulting\nCryptoKey is meant to protect, e.g.\n`{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource\ntypes.\n\n`string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];`\n\n### getResourceTypeSelectorBytes()\n\n public abstract ByteString getResourceTypeSelectorBytes()\n\nRequired. Indicates the resource type that the resulting\nCryptoKey is meant to protect, e.g.\n`{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource\ntypes.\n\n`string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];`"]]