Start-RayFlowFileDownload

<< Click to Display Table of Contents >>

RayFlow PowerShell API > 7.3 > Implementation Guide > Cmdlet Reference 

Start-RayFlowFileDownload

Description

Downloads a file from RayFlow task.

 

Parameters

Name

Type

Mandatory

Description

File

PsRayFlowFile[]

Yes

The file(s) to be downloaded. You can get the right instances by inspecting the Files property of a RayFlowTaskInfo, which is returned by the Get-RayFlowTask command let.

TargetFolder

DirectoryInfo

No

The output folder where the files will be downloaded.

 

Remarks

If TargetFolder is not specified, RayFlow saves the files in a temporary location. It is the user responsibility to clean up these files when they are not anymore needed.

 

Returns

Type

Description

FileInfo[]

Local downloaded file(s).