Full path: /system/sftp/rmdir-wildcard
Deletes from the SFTP server any directories that match a wildcard (e.g., TEST*). This function returns a list of strings with the deleted directory names if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter (see details below).
Parameters
Name |
Type |
Description |
|---|---|---|
SFTP Connection |
SFTP Connection |
Mandatory parameter. This is a FlowForce object that establishes an SFTP connection. To get the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step. |
Wildcard |
string |
Mandatory parameter. Specifies a wildcard, for example, TEST*. Any directories matching the wildcard will be deleted. Directories must be empty for the operation to succeed. See also Wildcards in SFTP functions. |
Abort on error |
boolean |
This parameter determines what should be the return value of the function if the execution fails. If this parameter is false, the function will return the list of directory names that have been successfully deleted and omit those directory names that cannot be deleted for some reason. If this parameter is true, the job execution is aborted in the first directory that cannot be deleted. The default value is true. |
