delete-wildcard
Deletes files from an SFTP server if the files match the specified wildcard. If execution is successful, the function returns the list of deleted files. 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 | Optional parameter. This parameter determines the outcome of a job in which an error has occurred. If this parameter is false, the function will return the list of directory names that have been deleted successfully 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. |