User specified key id (optional). If specified, it will become the final
component of the key resource name.
The id must be unique within the project, must conform with RFC-1034,
is restricted to lower-cased letters, and has a maximum length of 63
characters. In another word, the id must match the regular
expression: a-z?.
User specified key id (optional). If specified, it will become the final
component of the key resource name.
The id must be unique within the project, must conform with RFC-1034,
is restricted to lower-cased letters, and has a maximum length of 63
characters. In another word, the id must match the regular
expression: a-z?.
[[["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 CreateKeyRequestOrBuilder (0.70.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.70.0 (latest)](/java/docs/reference/google-cloud-apikeys/latest/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.68.0](/java/docs/reference/google-cloud-apikeys/0.68.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.66.0](/java/docs/reference/google-cloud-apikeys/0.66.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.65.0](/java/docs/reference/google-cloud-apikeys/0.65.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.62.0](/java/docs/reference/google-cloud-apikeys/0.62.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.61.0](/java/docs/reference/google-cloud-apikeys/0.61.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.60.0](/java/docs/reference/google-cloud-apikeys/0.60.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.58.0](/java/docs/reference/google-cloud-apikeys/0.58.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.57.0](/java/docs/reference/google-cloud-apikeys/0.57.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.56.0](/java/docs/reference/google-cloud-apikeys/0.56.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.55.0](/java/docs/reference/google-cloud-apikeys/0.55.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.54.0](/java/docs/reference/google-cloud-apikeys/0.54.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.53.0](/java/docs/reference/google-cloud-apikeys/0.53.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.52.0](/java/docs/reference/google-cloud-apikeys/0.52.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.51.0](/java/docs/reference/google-cloud-apikeys/0.51.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.50.0](/java/docs/reference/google-cloud-apikeys/0.50.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.49.0](/java/docs/reference/google-cloud-apikeys/0.49.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.47.0](/java/docs/reference/google-cloud-apikeys/0.47.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.46.0](/java/docs/reference/google-cloud-apikeys/0.46.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.45.0](/java/docs/reference/google-cloud-apikeys/0.45.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.44.0](/java/docs/reference/google-cloud-apikeys/0.44.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.43.0](/java/docs/reference/google-cloud-apikeys/0.43.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.42.0](/java/docs/reference/google-cloud-apikeys/0.42.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.41.0](/java/docs/reference/google-cloud-apikeys/0.41.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.40.0](/java/docs/reference/google-cloud-apikeys/0.40.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.39.0](/java/docs/reference/google-cloud-apikeys/0.39.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.38.0](/java/docs/reference/google-cloud-apikeys/0.38.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.37.0](/java/docs/reference/google-cloud-apikeys/0.37.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.35.0](/java/docs/reference/google-cloud-apikeys/0.35.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.34.0](/java/docs/reference/google-cloud-apikeys/0.34.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.33.0](/java/docs/reference/google-cloud-apikeys/0.33.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.32.0](/java/docs/reference/google-cloud-apikeys/0.32.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.31.0](/java/docs/reference/google-cloud-apikeys/0.31.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.30.0](/java/docs/reference/google-cloud-apikeys/0.30.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.29.0](/java/docs/reference/google-cloud-apikeys/0.29.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.28.0](/java/docs/reference/google-cloud-apikeys/0.28.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.27.0](/java/docs/reference/google-cloud-apikeys/0.27.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.26.0](/java/docs/reference/google-cloud-apikeys/0.26.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.25.0](/java/docs/reference/google-cloud-apikeys/0.25.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.22.0](/java/docs/reference/google-cloud-apikeys/0.22.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.21.0](/java/docs/reference/google-cloud-apikeys/0.21.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.20.0](/java/docs/reference/google-cloud-apikeys/0.20.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.19.0](/java/docs/reference/google-cloud-apikeys/0.19.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.18.0](/java/docs/reference/google-cloud-apikeys/0.18.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.17.0](/java/docs/reference/google-cloud-apikeys/0.17.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.16.0](/java/docs/reference/google-cloud-apikeys/0.16.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.15.0](/java/docs/reference/google-cloud-apikeys/0.15.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.14.0](/java/docs/reference/google-cloud-apikeys/0.14.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.13.0](/java/docs/reference/google-cloud-apikeys/0.13.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.12.0](/java/docs/reference/google-cloud-apikeys/0.12.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.11.0](/java/docs/reference/google-cloud-apikeys/0.11.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.10.0](/java/docs/reference/google-cloud-apikeys/0.10.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.9.0](/java/docs/reference/google-cloud-apikeys/0.9.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.8.0](/java/docs/reference/google-cloud-apikeys/0.8.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.7.0](/java/docs/reference/google-cloud-apikeys/0.7.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.6.0](/java/docs/reference/google-cloud-apikeys/0.6.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.5.0](/java/docs/reference/google-cloud-apikeys/0.5.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.4.0](/java/docs/reference/google-cloud-apikeys/0.4.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.3.0](/java/docs/reference/google-cloud-apikeys/0.3.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.2.0](/java/docs/reference/google-cloud-apikeys/0.2.0/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder)\n- [0.1.2](/java/docs/reference/google-cloud-apikeys/0.1.2/com.google.api.apikeys.v2.CreateKeyRequestOrBuilder) \n\n public interface CreateKeyRequestOrBuilder 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### getKey()\n\n public abstract Key getKey()\n\nRequired. The API key fields to set at creation time.\nYou can configure only the `display_name`, `restrictions`, and\n`annotations` fields.\n\n`.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### getKeyId()\n\n public abstract String getKeyId()\n\nUser specified key id (optional). If specified, it will become the final\ncomponent of the key resource name.\n\nThe id must be unique within the project, must conform with RFC-1034,\nis restricted to lower-cased letters, and has a maximum length of 63\ncharacters. In another word, the id must match the regular\nexpression: [a-z](/java/docs/reference/google-cloud-apikeys/latest/[a-z0-9-]{0,61}[a-z0-9])`?`.\n\nThe id must NOT be a UUID-like string.\n\n`string key_id = 3;`\n\n### getKeyIdBytes()\n\n public abstract ByteString getKeyIdBytes()\n\nUser specified key id (optional). If specified, it will become the final\ncomponent of the key resource name.\n\nThe id must be unique within the project, must conform with RFC-1034,\nis restricted to lower-cased letters, and has a maximum length of 63\ncharacters. In another word, the id must match the regular\nexpression: [a-z](/java/docs/reference/google-cloud-apikeys/latest/[a-z0-9-]{0,61}[a-z0-9])`?`.\n\nThe id must NOT be a UUID-like string.\n\n`string key_id = 3;`\n\n### getKeyOrBuilder()\n\n public abstract KeyOrBuilder getKeyOrBuilder()\n\nRequired. The API key fields to set at creation time.\nYou can configure only the `display_name`, `restrictions`, and\n`annotations` fields.\n\n`.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### getParent()\n\n public abstract String getParent()\n\nRequired. The project in which the API key is created.\n\n`\nstring parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`\n\n### getParentBytes()\n\n public abstract ByteString getParentBytes()\n\nRequired. The project in which the API key is created.\n\n`\nstring parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`\n\n### hasKey()\n\n public abstract boolean hasKey()\n\nRequired. The API key fields to set at creation time.\nYou can configure only the `display_name`, `restrictions`, and\n`annotations` fields.\n\n`.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];`"]]