Creates a folder in the resource hierarchy. Returns an Operation
which
can be used to track the progress of the folder creation workflow. Upon
success, the Operation.response
field will be populated with the
created Folder. In order to succeed, the addition of this new folder
must not violate the folder naming, height, or fanout constraints. + The
folder's display_name
must be distinct from all other folders that
share its parent. + The addition of the folder must not cause the active
folder hierarchy to exceed a height of 10. Note, the full active +
deleted folder hierarchy is allowed to reach a height of 20; this
provides additional headroom when moving folders that contain deleted
folders. + The addition of the folder must not cause the total number of
folders under its parent to exceed 300. If the operation fails due to a
folder constraint violation, some errors may be returned by the
CreateFolder
request, with status code FAILED_PRECONDITION
and an
error description. Other folder constraint violations will be
communicated in the Operation
, with the specific PreconditionFailure
returned in the details list in the Operation.error
field. The caller
must have resourcemanager.folders.create
permission on the identified
parent.
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 | |
---|---|
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
- create: call: googleapis.cloudresourcemanager.v3.folders.create args: body: displayName: ... parent: ... result: createResult
JSON
[ { "create": { "call": "googleapis.cloudresourcemanager.v3.folders.create", "args": { "body": { "displayName": "...", "parent": "..." } }, "result": "createResult" } } ]