Moves a folder under a new resource parent. Returns an Operation
which
can be used to track the progress of the folder move workflow. Upon
success, the Operation.response
field will be populated with the moved
folder. Upon failure, a FolderOperationError
categorizing the failure
cause will be returned - if the failure occurs synchronously then the FolderOperationError
will be returned in the Status.details
field.
If it occurs asynchronously, then the FolderOperation will be returned
in the Operation.error
field. In addition, the Operation.metadata
field will be populated with a FolderOperation
message as an aid to
stateless clients. Folder moves will be rejected if they violate either
the naming, height, or fanout constraints described in the CreateFolder
documentation. The caller must have resourcemanager.folders.move
permission on the folder's current and proposed new 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
name
string
Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}
body
object ( MoveFolderRequest
)
Required.
Raised exceptions
ConnectionError
HttpError
TimeoutError
TypeError
ValueError
OperationError
ResponseTypeError
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
- move : call : googleapis.cloudresourcemanager.v3.folders.move args : name : ... body : destinationParent : ... result : moveResult
JSON
[ { "move" : { "call" : "googleapis.cloudresourcemanager.v3.folders.move" , "args" : { "name" : "..." , "body" : { "destinationParent" : "..." } }, "result" : "moveResult" } } ]
