Required. Set the name field to the resource name of the API key to be
updated. You can update only the display_name, restrictions, and
annotations fields.
Required. Set the name field to the resource name of the API key to be
updated. You can update only the display_name, restrictions, and
annotations fields.
The field mask specifies which fields to be updated as part of this
request. All other fields are ignored.
Mutable fields are: display_name, restrictions, and annotations.
If an update mask is not provided, the service treats it as an implied mask
equivalent to all allowed fields that are set on the wire. If the field
mask has a special value "*", the service treats it equivalent to replace
all allowed mutable fields.
The field mask specifies which fields to be updated as part of this
request. All other fields are ignored.
Mutable fields are: display_name, restrictions, and annotations.
If an update mask is not provided, the service treats it as an implied mask
equivalent to all allowed fields that are set on the wire. If the field
mask has a special value "*", the service treats it equivalent to replace
all allowed mutable fields.
Required. Set the name field to the resource name of the API key to be
updated. You can update only the display_name, restrictions, and
annotations fields.
The field mask specifies which fields to be updated as part of this
request. All other fields are ignored.
Mutable fields are: display_name, restrictions, and annotations.
If an update mask is not provided, the service treats it as an implied mask
equivalent to all allowed fields that are set on the wire. If the field
mask has a special value "*", the service treats it equivalent to replace
all allowed mutable fields.
[[["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 UpdateKeyRequestOrBuilder (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.UpdateKeyRequestOrBuilder)\n- [0.68.0](/java/docs/reference/google-cloud-apikeys/0.68.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.66.0](/java/docs/reference/google-cloud-apikeys/0.66.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.65.0](/java/docs/reference/google-cloud-apikeys/0.65.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.62.0](/java/docs/reference/google-cloud-apikeys/0.62.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.61.0](/java/docs/reference/google-cloud-apikeys/0.61.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.60.0](/java/docs/reference/google-cloud-apikeys/0.60.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.58.0](/java/docs/reference/google-cloud-apikeys/0.58.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.57.0](/java/docs/reference/google-cloud-apikeys/0.57.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.56.0](/java/docs/reference/google-cloud-apikeys/0.56.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.55.0](/java/docs/reference/google-cloud-apikeys/0.55.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.54.0](/java/docs/reference/google-cloud-apikeys/0.54.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.53.0](/java/docs/reference/google-cloud-apikeys/0.53.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.52.0](/java/docs/reference/google-cloud-apikeys/0.52.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.51.0](/java/docs/reference/google-cloud-apikeys/0.51.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.50.0](/java/docs/reference/google-cloud-apikeys/0.50.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.49.0](/java/docs/reference/google-cloud-apikeys/0.49.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.47.0](/java/docs/reference/google-cloud-apikeys/0.47.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.46.0](/java/docs/reference/google-cloud-apikeys/0.46.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.45.0](/java/docs/reference/google-cloud-apikeys/0.45.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.44.0](/java/docs/reference/google-cloud-apikeys/0.44.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.43.0](/java/docs/reference/google-cloud-apikeys/0.43.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.42.0](/java/docs/reference/google-cloud-apikeys/0.42.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.41.0](/java/docs/reference/google-cloud-apikeys/0.41.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.40.0](/java/docs/reference/google-cloud-apikeys/0.40.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.39.0](/java/docs/reference/google-cloud-apikeys/0.39.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.38.0](/java/docs/reference/google-cloud-apikeys/0.38.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.37.0](/java/docs/reference/google-cloud-apikeys/0.37.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.35.0](/java/docs/reference/google-cloud-apikeys/0.35.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.34.0](/java/docs/reference/google-cloud-apikeys/0.34.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.33.0](/java/docs/reference/google-cloud-apikeys/0.33.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.32.0](/java/docs/reference/google-cloud-apikeys/0.32.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.31.0](/java/docs/reference/google-cloud-apikeys/0.31.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.30.0](/java/docs/reference/google-cloud-apikeys/0.30.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.29.0](/java/docs/reference/google-cloud-apikeys/0.29.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.28.0](/java/docs/reference/google-cloud-apikeys/0.28.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.27.0](/java/docs/reference/google-cloud-apikeys/0.27.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.26.0](/java/docs/reference/google-cloud-apikeys/0.26.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.25.0](/java/docs/reference/google-cloud-apikeys/0.25.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.22.0](/java/docs/reference/google-cloud-apikeys/0.22.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.21.0](/java/docs/reference/google-cloud-apikeys/0.21.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.20.0](/java/docs/reference/google-cloud-apikeys/0.20.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.19.0](/java/docs/reference/google-cloud-apikeys/0.19.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.18.0](/java/docs/reference/google-cloud-apikeys/0.18.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.17.0](/java/docs/reference/google-cloud-apikeys/0.17.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.16.0](/java/docs/reference/google-cloud-apikeys/0.16.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.15.0](/java/docs/reference/google-cloud-apikeys/0.15.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.14.0](/java/docs/reference/google-cloud-apikeys/0.14.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.13.0](/java/docs/reference/google-cloud-apikeys/0.13.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.12.0](/java/docs/reference/google-cloud-apikeys/0.12.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.11.0](/java/docs/reference/google-cloud-apikeys/0.11.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.10.0](/java/docs/reference/google-cloud-apikeys/0.10.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.9.0](/java/docs/reference/google-cloud-apikeys/0.9.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.8.0](/java/docs/reference/google-cloud-apikeys/0.8.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.7.0](/java/docs/reference/google-cloud-apikeys/0.7.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.6.0](/java/docs/reference/google-cloud-apikeys/0.6.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.5.0](/java/docs/reference/google-cloud-apikeys/0.5.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.4.0](/java/docs/reference/google-cloud-apikeys/0.4.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.3.0](/java/docs/reference/google-cloud-apikeys/0.3.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.2.0](/java/docs/reference/google-cloud-apikeys/0.2.0/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder)\n- [0.1.2](/java/docs/reference/google-cloud-apikeys/0.1.2/com.google.api.apikeys.v2.UpdateKeyRequestOrBuilder) \n\n public interface UpdateKeyRequestOrBuilder 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. Set the `name` field to the resource name of the API key to be\nupdated. You can update only the `display_name`, `restrictions`, and\n`annotations` fields.\n\n`.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];`\n\n### getKeyOrBuilder()\n\n public abstract KeyOrBuilder getKeyOrBuilder()\n\nRequired. Set the `name` field to the resource name of the API key to be\nupdated. You can update only the `display_name`, `restrictions`, and\n`annotations` fields.\n\n`.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];`\n\n### getUpdateMask()\n\n public abstract FieldMask getUpdateMask()\n\nThe field mask specifies which fields to be updated as part of this\nrequest. All other fields are ignored.\nMutable fields are: `display_name`, `restrictions`, and `annotations`.\nIf an update mask is not provided, the service treats it as an implied mask\nequivalent to all allowed fields that are set on the wire. If the field\nmask has a special value \"\\*\", the service treats it equivalent to replace\nall allowed mutable fields.\n\n`.google.protobuf.FieldMask update_mask = 2;`\n\n### getUpdateMaskOrBuilder()\n\n public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()\n\nThe field mask specifies which fields to be updated as part of this\nrequest. All other fields are ignored.\nMutable fields are: `display_name`, `restrictions`, and `annotations`.\nIf an update mask is not provided, the service treats it as an implied mask\nequivalent to all allowed fields that are set on the wire. If the field\nmask has a special value \"\\*\", the service treats it equivalent to replace\nall allowed mutable fields.\n\n`.google.protobuf.FieldMask update_mask = 2;`\n\n### hasKey()\n\n public abstract boolean hasKey()\n\nRequired. Set the `name` field to the resource name of the API key to be\nupdated. You can update only the `display_name`, `restrictions`, and\n`annotations` fields.\n\n`.google.api.apikeys.v2.Key key = 1 [(.google.api.field_behavior) = REQUIRED];`\n\n### hasUpdateMask()\n\n public abstract boolean hasUpdateMask()\n\nThe field mask specifies which fields to be updated as part of this\nrequest. All other fields are ignored.\nMutable fields are: `display_name`, `restrictions`, and `annotations`.\nIf an update mask is not provided, the service treats it as an implied mask\nequivalent to all allowed fields that are set on the wire. If the field\nmask has a special value \"\\*\", the service treats it equivalent to replace\nall allowed mutable fields.\n\n`.google.protobuf.FieldMask update_mask = 2;`"]]