Method: googleapis.cloudresourcemanager.v3.tagKeys.patch

Updates the attributes of the TagKey resource.

This method waits—the workflow execution is paused—until the operation iscomplete, fails, or times out. The default timeout value is1800 seconds (30minutes) and can be changed to a maximum value of31536000 seconds (one year)for long-running operations using theconnector_params field. See theConnectors reference.

The connector uses polling to monitor the long-running operation, which mightgenerate additional billable steps. For more information about retries andlong-running operations, refer toUnderstand connectors.

The polling policy for the long-running operation can be configured. To set theconnector-specific parameters (connector_params), refer toInvoke a connector call.

Arguments

Parameters
name

string

Required. Immutable. The resource name for a TagKey. Must be in the formattagKeys/{tag_key_id}, wheretag_key_id is the generated numeric id for the TagKey.

updateMask

string (FieldMask format)

Fields to be updated. The mask may only containdescription oretag. If omitted entirely, bothdescription andetag are assumed to be significant.

validateOnly

boolean

Set as true to perform validations necessary for updating the resource, but not actually perform the action.

body

object (TagKey)

Required.

Raised exceptions

Exceptions
ConnectionErrorIn case of a network problem (such as DNS failure or refused connection).
HttpErrorIf the response status is >= 400 (excluding 429 and 503).
TimeoutErrorIf a long-running operation takes longer to finish than the specified timeout limit.
TypeErrorIf an operation or function receives an argument of the wrong type.
ValueErrorIf an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
OperationErrorIf the long-running operation finished unsuccessfully.
ResponseTypeErrorIf the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance ofOperation.

Subworkflow snippet

Some fields might be optional or required.To identify required fields, refer to theAPI documentation.

YAML

-patch:call:googleapis.cloudresourcemanager.v3.tagKeys.patchargs:name:...updateMask:...validateOnly:...body:description:...etag:...name:...parent:...shortName:...result:patchResult

JSON

[{"patch":{"call":"googleapis.cloudresourcemanager.v3.tagKeys.patch","args":{"name":"...","updateMask":"...","validateOnly":"...","body":{"description":"...","etag":"...","name":"...","parent":"...","shortName":"..."}},"result":"patchResult"}}]

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.