Table of Contents

FileMoveValve

Warning

This valve is blocking - this may hurt throughput and cause performance issues since other pipes won't be able to execute while this valve is waiting on a long-running operation in the same instance of the pipes module, for example due to a network request, disk access or similar. Try to limit the usage of blocking valves, try to ensure that they are fast to execute, and if needed, consider deploying multiple instances of the pipes module.

Note

Valve to move a file.

Valve operates on the Current Item Set and will process all items surviving the common item filtering rules.

Properties

Name Description Default value Mandatory Supports property expansion
path The path of the file to move. Yes Yes
dest The destination path Yes Yes
overwrite_existing Flag controlling what to do if destination exist false No No

Example Configuration

{
    "name": "FileMoveValve",
    "config": { 
        "path":"C:\\Windows\\Temp\\file.txt",
        "dest":"C:\\Users\\{{item.username}}\\file.txt",
        "overwrite_existing" : "true"
    }
}

Requirements

Item set must have at least one entry.