Actions YAML Reference
Properties | List of all members
FileFilter Class Reference

Specifies the filter properties to use to filter files. More...

Properties

string FilePattern [get, set]
 Specifies the file pattern to use when iterating the folder (for example, *.csv). Supports regular expressions and variable substitution. More...
 
FilterType FilePatternFilterType [get, set]
 Specifies the file pattern type, as follows: More...
 
int MinimumFileSize [get, set]
 Specifies the minimum file size that a file must have to be included. The default value is 0. More...
 
int MaximumFileSize [get, set]
 Specifies the maximum file size that a file cannot exceed to be included. The default value is -1, which specifies that there is no file size limitation. More...
 
long FilesOlderThan [get, set]
 Specifies that files that are older than the specified amount of time, in milliseconds, are included. The default value is -1, which specifies that this filter is not used. More...
 
string DetectFileState [get, set]
 Specifies that an event occurs when the state of the file is changed to the specified file state. More...
 
bool CanDetectFileStateChanged [get, set]
 Enables or disables the file state option. More...
 
bool DetectFileChanged [get, set]
 Specifies that an event occurs when the file is changed. More...
 
bool DetectFileCreated [get, set]
 Specifies that an event occurs when a new file is created. The default value is true. More...
 

Detailed Description

Specifies the filter properties to use to filter files.

Example:

FileFilter:
FilePattern: '*.txt'
FilesOlderThan: 3600000
int MaximumFileSize
Specifies the maximum file size that a file cannot exceed to be included. The default value is -1,...
Definition: FileFilter.Properties.cs:144
string FilePattern
Specifies the file pattern to use when iterating the folder (for example, *.csv). Supports regular ex...
Definition: FileFilter.Properties.cs:84
long FilesOlderThan
Specifies that files that are older than the specified amount of time, in milliseconds,...
Definition: FileFilter.Properties.cs:157

Property Documentation

◆ FilePattern

string FilePattern
getset

Specifies the file pattern to use when iterating the folder (for example, *.csv). Supports regular expressions and variable substitution.

◆ FilePatternFilterType

FilterType FilePatternFilterType
getset

Specifies the file pattern type, as follows:

  • Wildcard (default)
  • RegularExpression

◆ MinimumFileSize

int MinimumFileSize
getset

Specifies the minimum file size that a file must have to be included. The default value is 0.

◆ MaximumFileSize

int MaximumFileSize
getset

Specifies the maximum file size that a file cannot exceed to be included. The default value is -1, which specifies that there is no file size limitation.

◆ FilesOlderThan

long FilesOlderThan
getset

Specifies that files that are older than the specified amount of time, in milliseconds, are included. The default value is -1, which specifies that this filter is not used.

◆ DetectFileState

string DetectFileState
getset

Specifies that an event occurs when the state of the file is changed to the specified file state.

◆ CanDetectFileStateChanged

bool CanDetectFileStateChanged
getset

Enables or disables the file state option.

◆ DetectFileChanged

bool DetectFileChanged
getset

Specifies that an event occurs when the file is changed.

◆ DetectFileCreated

bool DetectFileCreated
getset

Specifies that an event occurs when a new file is created. The default value is true.


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