Remove File
The Remove File operator is used to remove files in a storage service.
This operation is recursive, meaning it will remove any files under the given path.
Configuration Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
service |
string |
The file service to operate. Additional parameters may depend on the selected service. Default: "file" |
|
terminateOnError |
boolean |
Sets if the graph should terminate when the operator fails. Default: "true" |
|
timeoutInMs |
int |
Sets the time limit to execute the operation. If `0`, no timeout is used. Default: 0 |
|
retryPeriodInMs |
int |
The time interval in milliseconds between connection trials. Default: 0 |
|
numRetryAttempts |
int |
The number of times to retry a connection. Default: 0 |
|
simultaneousRequests |
int |
The number of simultaneous requests generated on recursive calls (only available for GCS, S3 and WASB). Default: 1 |
|
stopRequestOnError |
boolean |
Sets if simultaneous requests from recursive calls should stop at first error (only available for GCS, S3 and WASB). Default: false |
|
connection |
object |
Holds information about connection information for the services. Each service connection
parameters is documented separately:
|
|
configurationType |
string |
connection parameter: Which type of connection information will be used: Manual (user input) or retrieved by the Connection Management Service. Default: "" |
|
connectionID |
string |
connection parameter: The ID of the connection information to retrieve from the Connection Management Service. Default: "" |
|
connectionProperties |
object |
connection parameter: All the connection properties for the selected service for manual input. |
Input
|
Input |
Type |
Description |
|---|---|---|
|
in |
message |
A message whose body is the path (relative or absolute) of a file or directory to be removed. |
Output
|
Output |
Type |
Description |
|---|---|---|
|
out |
message |
A message whose header message.error (bool) reports whether the operation was successful. The body and any other header from the input message are copied to this one. |