Download Storage File

Downloads a file from an Orchestrator storage bucket to a local path.

Behaviour

Risk: Low · Idempotent: Yes · Safe to retry: Yes · Recovery: Not replayed after a crash

Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.storage.downloadFile

Properties#

Input#

Bucket#

Bucket · String · Required · Default: Not specified in package metadata

The storage bucket's name, such as 'Invoices'. It must exist in the job's workspace or be shared into it.

Path in Bucket#

PathInBucket · String · Required · Default: Not specified in package metadata

The file's path in the bucket, such as 'invoices/inv-1.pdf'.

Local Path#

LocalPath · String · Required · Default: Not specified in package metadata

The file to write, or an existing folder to write the file into under its own name.

Options#

Fail If Exists#

FailIfExists · Boolean · Optional · Default: False

Fail instead of replacing a file already at the local path.

Output#

Local File#

LocalFile · String · Output

The full path of the downloaded file.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Delete Storage File
• List Storage Files
• Read Storage Text
• Upload Storage File
• Write Storage Text

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Storage. Keywords: storage, bucket, download, file, get, fetch, orchestrator.

Properties

Input

Options

Output

Retry and risk

Related activities