Optional. A checksum computed by the server based on the value of other
fields. This may be sent on update requests to ensure that the client has
an up-to-date value before proceeding. The request will be rejected with an
ABORTED error on a mismatched etag.
Optional. A checksum computed by the server based on the value of other
fields. This may be sent on update requests to ensure that the client has
an up-to-date value before proceeding. The request will be rejected with an
ABORTED error on a mismatched etag.
Optional. Name of the key project, e.g. projects/{PROJECT_ID} or
projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new
CryptoKey when a
KeyHandle is created. On
UpdateAutokeyConfig,
the caller will require cloudkms.cryptoKeys.setIamPolicy permission on
this key project. Once configured, for Cloud KMS Autokey to function
properly, this key project must have the Cloud KMS API activated and the
Cloud KMS Service Agent for this key project must be granted the
cloudkms.admin role (or pertinent permissions). A request with an empty
key project field will clear the configuration.
Optional. Name of the key project, e.g. projects/{PROJECT_ID} or
projects/{PROJECT_NUMBER}, where Cloud KMS Autokey will provision a new
CryptoKey when a
KeyHandle is created. On
UpdateAutokeyConfig,
the caller will require cloudkms.cryptoKeys.setIamPolicy permission on
this key project. Once configured, for Cloud KMS Autokey to function
properly, this key project must have the Cloud KMS API activated and the
Cloud KMS Service Agent for this key project must be granted the
cloudkms.admin role (or pertinent permissions). A request with an empty
key project field will clear the configuration.
[[["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 AutokeyConfigOrBuilder (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.AutokeyConfigOrBuilder)\n- [2.73.0](/java/docs/reference/google-cloud-kms/2.73.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.71.0](/java/docs/reference/google-cloud-kms/2.71.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.70.0](/java/docs/reference/google-cloud-kms/2.70.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.67.0](/java/docs/reference/google-cloud-kms/2.67.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.66.0](/java/docs/reference/google-cloud-kms/2.66.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.65.0](/java/docs/reference/google-cloud-kms/2.65.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.63.0](/java/docs/reference/google-cloud-kms/2.63.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.62.0](/java/docs/reference/google-cloud-kms/2.62.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.61.0](/java/docs/reference/google-cloud-kms/2.61.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.60.0](/java/docs/reference/google-cloud-kms/2.60.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.59.0](/java/docs/reference/google-cloud-kms/2.59.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.58.0](/java/docs/reference/google-cloud-kms/2.58.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.57.0](/java/docs/reference/google-cloud-kms/2.57.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.56.0](/java/docs/reference/google-cloud-kms/2.56.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.55.0](/java/docs/reference/google-cloud-kms/2.55.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.54.0](/java/docs/reference/google-cloud-kms/2.54.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.52.0](/java/docs/reference/google-cloud-kms/2.52.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.51.0](/java/docs/reference/google-cloud-kms/2.51.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.50.0](/java/docs/reference/google-cloud-kms/2.50.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.49.0](/java/docs/reference/google-cloud-kms/2.49.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.48.0](/java/docs/reference/google-cloud-kms/2.48.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.47.0](/java/docs/reference/google-cloud-kms/2.47.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.46.0](/java/docs/reference/google-cloud-kms/2.46.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.45.0](/java/docs/reference/google-cloud-kms/2.45.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.44.0](/java/docs/reference/google-cloud-kms/2.44.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.43.0](/java/docs/reference/google-cloud-kms/2.43.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.42.0](/java/docs/reference/google-cloud-kms/2.42.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.40.0](/java/docs/reference/google-cloud-kms/2.40.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.39.0](/java/docs/reference/google-cloud-kms/2.39.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.38.0](/java/docs/reference/google-cloud-kms/2.38.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.37.0](/java/docs/reference/google-cloud-kms/2.37.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.36.0](/java/docs/reference/google-cloud-kms/2.36.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.35.0](/java/docs/reference/google-cloud-kms/2.35.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.34.0](/java/docs/reference/google-cloud-kms/2.34.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.33.0](/java/docs/reference/google-cloud-kms/2.33.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.32.0](/java/docs/reference/google-cloud-kms/2.32.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.31.0](/java/docs/reference/google-cloud-kms/2.31.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.30.0](/java/docs/reference/google-cloud-kms/2.30.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.27.0](/java/docs/reference/google-cloud-kms/2.27.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.26.0](/java/docs/reference/google-cloud-kms/2.26.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.25.0](/java/docs/reference/google-cloud-kms/2.25.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.24.0](/java/docs/reference/google-cloud-kms/2.24.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.23.0](/java/docs/reference/google-cloud-kms/2.23.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.22.0](/java/docs/reference/google-cloud-kms/2.22.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.21.0](/java/docs/reference/google-cloud-kms/2.21.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.20.0](/java/docs/reference/google-cloud-kms/2.20.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.19.0](/java/docs/reference/google-cloud-kms/2.19.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.18.0](/java/docs/reference/google-cloud-kms/2.18.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.17.0](/java/docs/reference/google-cloud-kms/2.17.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.16.0](/java/docs/reference/google-cloud-kms/2.16.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.15.0](/java/docs/reference/google-cloud-kms/2.15.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.14.0](/java/docs/reference/google-cloud-kms/2.14.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.12.0](/java/docs/reference/google-cloud-kms/2.12.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.11.0](/java/docs/reference/google-cloud-kms/2.11.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.10.0](/java/docs/reference/google-cloud-kms/2.10.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.9.0](/java/docs/reference/google-cloud-kms/2.9.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.8.0](/java/docs/reference/google-cloud-kms/2.8.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.7.0](/java/docs/reference/google-cloud-kms/2.7.0/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.6.8](/java/docs/reference/google-cloud-kms/2.6.8/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.5.3](/java/docs/reference/google-cloud-kms/2.5.3/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.4.4](/java/docs/reference/google-cloud-kms/2.4.4/com.google.cloud.kms.v1.AutokeyConfigOrBuilder)\n- [2.3.1](/java/docs/reference/google-cloud-kms/2.3.1/com.google.cloud.kms.v1.AutokeyConfigOrBuilder) \n\n public interface AutokeyConfigOrBuilder 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### getEtag()\n\n public abstract String getEtag()\n\nOptional. A checksum computed by the server based on the value of other\nfields. This may be sent on update requests to ensure that the client has\nan up-to-date value before proceeding. The request will be rejected with an\nABORTED error on a mismatched etag.\n\n`string etag = 6 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getEtagBytes()\n\n public abstract ByteString getEtagBytes()\n\nOptional. A checksum computed by the server based on the value of other\nfields. This may be sent on update requests to ensure that the client has\nan up-to-date value before proceeding. The request will be rejected with an\nABORTED error on a mismatched etag.\n\n`string etag = 6 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getKeyProject()\n\n public abstract String getKeyProject()\n\nOptional. Name of the key project, e.g. `projects/{PROJECT_ID}` or\n`projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new\nCryptoKey when a\nKeyHandle is created. On\nUpdateAutokeyConfig,\nthe caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on\nthis key project. Once configured, for Cloud KMS Autokey to function\nproperly, this key project must have the Cloud KMS API activated and the\nCloud KMS Service Agent for this key project must be granted the\n`cloudkms.admin` role (or pertinent permissions). A request with an empty\nkey project field will clear the configuration.\n\n`string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getKeyProjectBytes()\n\n public abstract ByteString getKeyProjectBytes()\n\nOptional. Name of the key project, e.g. `projects/{PROJECT_ID}` or\n`projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new\nCryptoKey when a\nKeyHandle is created. On\nUpdateAutokeyConfig,\nthe caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on\nthis key project. Once configured, for Cloud KMS Autokey to function\nproperly, this key project must have the Cloud KMS API activated and the\nCloud KMS Service Agent for this key project must be granted the\n`cloudkms.admin` role (or pertinent permissions). A request with an empty\nkey project field will clear the configuration.\n\n`string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getName()\n\n public abstract String getName()\n\nIdentifier. Name of the AutokeyConfig\nresource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.\n\n`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];`\n\n### getNameBytes()\n\n public abstract ByteString getNameBytes()\n\nIdentifier. Name of the AutokeyConfig\nresource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.\n\n`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];`\n\n### getState()\n\n public abstract AutokeyConfig.State getState()\n\nOutput only. The state for the AutokeyConfig.\n\n`\n.google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### getStateValue()\n\n public abstract int getStateValue()\n\nOutput only. The state for the AutokeyConfig.\n\n`\n.google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`"]]