DeleteFileAction Class Reference

Deletes one or more files. More...

Inherits IntegrationAction, and ISourceFilesOptions.

Properties
bool	InMultipleFilesMode [get, set]
	Specifies whether the action is in multiple-files mode. If the value of this property is true, the files in SourceFolder that match FileFilter will be deleted. The default value is false. More...
FileTarget	File [get, set]
	Specifies the file to be deleted. For information about how to specify a file in different file systems, see FileTarget. Valid only when the value of InMultipleFilesMode is false. More...
FolderTarget	MultiFilesSourceFolder [get, set]
	Specifies the source folder of the files when multiple-files mode is used. For information about how to specify a folder in different file systems, see FolderTarget. Valid only when the value of InMultipleFilesMode is true. More...
FileFilter	FileFilter [get, set]
	Specifies the filter properties to use to filter files. More...
bool	FailIfNotExist [get, set]
	Specifies whether the action fails if the specified file does not already exist. The default value is true. 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...

Detailed Description

Deletes one or more files.

For common action properties, see IntegrationAction.
Example in which one file is deleted:

Actions:
- DeleteFileAction:
    File: %FilePath%
    # And more common action properties
    ...

Example in which a file filter is used to delete multiple files:

Actions:
- DeleteFileAction:
    InMultipleFilesMode: true
    MultiFilesSourceFolder: '%FileFolder%'
    FileFilter:
      FilePattern: '*.failed'
      FilesOlderThan: 300000
    Name: Delete Some Files
    # And more common action properties
    ...

Property Documentation

InMultipleFilesMode

bool InMultipleFilesMode

getset

Specifies whether the action is in multiple-files mode. If the value of this property is true, the files in SourceFolder that match FileFilter will be deleted. The default value is false.

File

FileTarget File

getset

Specifies the file to be deleted. For information about how to specify a file in different file systems, see FileTarget. Valid only when the value of InMultipleFilesMode is false.

MultiFilesSourceFolder

FolderTarget MultiFilesSourceFolder

getset

Specifies the source folder of the files when multiple-files mode is used. For information about how to specify a folder in different file systems, see FolderTarget. Valid only when the value of InMultipleFilesMode is true.

FileFilter

FileFilter FileFilter

getset

Specifies the filter properties to use to filter files.

Example:

FileFilter:
  FilePattern: '*.txt'
  MaximumFileSize: 65536
  FilesOlderThan: 3600000

Valid only when the value of InMultipleFilesMode is true.

FailIfNotExist

bool FailIfNotExist

getset

Specifies whether the action fails if the specified file does not already exist. The default value is true.

Name

string Name

getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description

string Description

getsetinherited

Specifies the description. The default value is "".

RunType

ActionRunType RunType

getsetinherited

Runs the action by using one of the following types:

• Always (default)
• Never

IgnoreErrors

bool IgnoreErrors

getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries

int FailureRetries

getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval

int RetryInterval

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.

---

The documentation for this class was generated from the following file:

• DeleteFileAction.Properties.cs