Full path: /system/sftp/delete-wildcard
Deletes from the SFTP server any files that match a wildcard (e.g., *.xml). This function returns a list of strings with the deleted file names if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter (see 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, *.xml. Any files matching the wildcard will be deleted from the SFTP server. See also Wildcards in SFTP functions. |
Abort on error |
boolean |
This parameter determines what should be the return value of the function if execution fails. If this parameter is false, the function will return a list of directory names that have been successfully deleted and omit those file names that cannot be deleted for some reason. If this parameter is true, the job execution will be aborted in the first file that cannot be deleted. The default value is true. |
