RenameFileAction Class Reference

Renames a file. More...

Inherits IntegrationAction.

Properties
FileTarget	SourceFile [get, set]
	Specifies the path of the source file. For more examples of different kinds of file systems, see FileTarget. More...
FileTarget	DestinationFile [get, set]
	Specifies the path of the destination file. For more examples of different kinds of file systems, see FileTarget. 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...

Detailed Description

Renames a file.

Example:

Actions:
- RenameFileAction:
    SourceFile: C:\MyFolder\MyData.txt
    DestinationFile: NewFile.txt
    OverwriteFileOperation: Timestamp
    Name: Rename File
    # And more common action properties
    ...

Example:

Actions:
- RenameFileAction:
    SourceFile:
      Path: dropbox://slin523/Mydata.txt
      FileSystem.Dropbox:
        AccountName: My Dropbox
        UrlAccountName: MyDropbox
    DestinationFile:
      Path: NewFile.txt
      FileSystem.Dropbox:
        AccountName: My Dropbox
        UrlAccountName: MyDropbox
    OverwriteFileOperation: Serialize
    Name: Rename File
    # And more common action properties
    ...

Property Documentation

SourceFile

FileTarget SourceFile

getset

Specifies the path of the source file.
For more examples of different kinds of file systems, see FileTarget.

DestinationFile

FileTarget DestinationFile

getset

Specifies the path of the destination file.
For more examples of different kinds of file systems, see FileTarget.

OverwriteFileOperation

OverwriteFileOperation OverwriteFileOperation

getset

Specifies the action to take when a file that has the same name already exists in the folder, as follows:

• Replace: Specifies that the new content is saved to a file that replaces the existing file.
• Serialize: Specifies that the new content is saved to a file that uses a serialized number that has the "filename(%d).ext" format.
• Timestamp: Specifies that the new content is saved to a file that uses a timestamp that has the "filename(yyyy-MM-ddTHH.mm.ss.fff).ext" format.
• Failed: Specifies that the new content is not saved.

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:

• RenameFileAction.Properties.cs