Requests deletion of a folder. The folder is moved into the
DELETE_REQUESTED state immediately, and is deleted approximately 30 days
later. This method may only be called on an empty folder, where a folder
is empty if it doesn't contain any folders or projects in the ACTIVE
state. If called on a folder in DELETE_REQUESTED state the operation
will result in a no-op success. The caller must have
resourcemanager.folders.delete
permission on the identified folder.
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. The resource name of the folder to be deleted. Must be of the form |
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
- delete: call: googleapis.cloudresourcemanager.v3.folders.delete args: name: ... result: deleteResult
JSON
[ { "delete": { "call": "googleapis.cloudresourcemanager.v3.folders.delete", "args": { "name": "..." }, "result": "deleteResult" } } ]