Updates a folder, changing its display_name
. Changes to the folder
display_name
will be rejected if they violate either the
display_name
formatting rules or the naming constraints described in
the CreateFolder documentation. The folder's display_name
must start
and end with a letter or digit, may contain letters, digits, spaces,
hyphens and underscores and can be between 3 and 30 characters. This is
captured by the regular expression: \p{L}\p{N}{1,28}[\p{L}\p{N}]
.
The caller must have resourcemanager.folders.update
permission on the
identified folder. If the update fails due to the unique name constraint
then a PreconditionFailure
explaining this violation will be returned
in the Status.details field.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800
seconds (30
minutes) and can be changed to a maximum value of 31536000
seconds (one year)
for long-running operations using the connector_params
field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params
), refer to
Invoke a connector call.
Arguments
Parameters | |
---|---|
name |
Required. Output only. The resource name of the folder. Its format is |
updateMask |
Required. Fields to be updated. Only the |
body |
Required. |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of Operation
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- patch: call: googleapis.cloudresourcemanager.v3.folders.patch args: name: ... updateMask: ... body: displayName: ... parent: ... result: patchResult
JSON
[ { "patch": { "call": "googleapis.cloudresourcemanager.v3.folders.patch", "args": { "name": "...", "updateMask": "...", "body": { "displayName": "...", "parent": "..." } }, "result": "patchResult" } } ]