Method: googleapis.cloudresourcemanager.v2.folders.delete

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 in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. The caller must have resourcemanager.folders.delete permission on the identified folder.

Arguments

Parameters
name

string

Required. the resource name of the Folder to be deleted. Must be of the form folders/{folder_id}.

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.

Response

If successful, the response contains an instance of Folder.

Subworkflow snippet

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

YAML

- delete:
    call: googleapis.cloudresourcemanager.v2.folders.delete
    args:
        name: ...
    result: deleteResult

JSON

[
  {
    "delete": {
      "call": "googleapis.cloudresourcemanager.v2.folders.delete",
      "args": {
        "name": "..."
      },
      "result": "deleteResult"
    }
  }
]