Actions YAML Reference
|
Copies one or more files from one location to another. More...
Inherits IntegrationAction, and ISourceFilesOptions.
Inherited by MoveFileAction.
Properties | |
bool | InMultipleFilesMode [get, set] |
Determines whether the action is in multiple-files mode, where the files in MultiFilesSourceFolder that match the criteria of FileFilter are copied or moved. The default value is false. More... | |
FileTarget | SourceFile [get, set] |
Specifies the source file path. For information about how to specify a file in different file systems, see FileTarget. More... | |
FolderTarget | MultiFilesSourceFolder [get, set] |
Specifies the source folder of the files when working in multiple-files mode. For information about how to specify a folder in different file systems, see FolderTarget. More... | |
FileFilter | FileFilter [get, set] |
Specifies the filter properties to use to filter files. More... | |
FileTarget | DestinationFile [get, set] |
Specifies the destination file or folder path. To specify the destination file, set Destination.Path. For information about how to specify a folder in different file systems, see FileTarget and FolderTarget. More... | |
OverwriteFileOperation | OverwriteFileOperation [get, set] |
Specifies the action to take when a file that has the same name already exists in the folder, as follows: More... | |
CommonActionProperties | |
Describes the common action properties for Actions and ActionGroups. | |
string | Name [get, set] |
Specifies the name. This property cannot be empty and must be unique in the YAML script. More... | |
string | Description [get, set] |
Specifies the description. The default value is "". More... | |
ActionRunType | RunType [get, set] |
Runs the action by using one of the following types: More... | |
bool | IgnoreErrors [get, set] |
Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More... | |
int | FailureRetries [get, set] |
Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More... | |
int | RetryInterval [get, set] |
Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More... | |
Copies one or more files from one location to another.
For common action properties, see IntegrationAction.
Example of copying one file:
Example of copying multiple files:
Example of copying multiple cloud files:
|
getset |
Determines whether the action is in multiple-files mode, where the files in MultiFilesSourceFolder that match the criteria of FileFilter are copied or moved. The default value is false.
|
getset |
Specifies the source file path.
For information about how to specify a file in different file systems, see FileTarget.
|
getset |
Specifies the source folder of the files when working in multiple-files mode.
For information about how to specify a folder in different file systems, see FolderTarget.
|
getset |
Specifies the filter properties to use to filter files.
Example:
Valid only when the value of InMultipleFilesMode is true.
|
getset |
Specifies the destination file or folder path.
To specify the destination file, set Destination.Path.
For information about how to specify a folder in different file systems, see FileTarget and FolderTarget.
When in multiple-files mode, the path specifies a folder.
When in single-file mode, if the path has an ending separator, or if a folder exists at the path, it is a folder. Otherwise, it is the file name.
|
getset |
Specifies the action to take when a file that has the same name already exists in the folder, as follows:
|
getsetinherited |
Specifies the name. This property cannot be empty and must be unique in the YAML script.
|
getsetinherited |
Specifies the description. The default value is "".
|
getsetinherited |
Runs the action by using one of the following types:
|
getsetinherited |
Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.
|
getsetinherited |
Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.
|
getsetinherited |
Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.