Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for Download GCS

View as Markdown

Download files from Google Cloud Storage bucket.

YAML parameters for Download GCS

PARAMETERS
integrationrequiredstring
Google Cloud integration identifier for authentication.
bucket_namerequiredstring
The name of the Google Cloud Storage bucket to download from
source_pathrequiredstring
The path to the source file or directory to download
destination_pathrequiredstring
The path where the downloaded files will be saved
typerequiredstring

Value: DOWNLOAD_GCS

actionrequiredstring
Unique identifier for the action within the pipeline.
application_namestring
The name of the GCS application
recursiveboolean
If set to true, directories will be downloaded recursively
overwriteboolean
If set to true, existing files will be overwritten
download_excludesstring[]
The list of files or directories to exclude from download
download_includesstring[]
The list of files or directories to include in download
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Apr 27, 2026

Previous pageDownload Backblaze B2Next pageDownload S3

YAML examples for Download GCS

Download files from Google Cloud Storage

yaml
  - action: "Download from GCS"
    type: "DOWNLOAD_GCS"
    bucket_name: "my-gcs-bucket"
    application_name: "my-gcp-project"
    source_path: "/backup"
    destination_path: "/restore"
    recursive: true
    overwrite: true
    integration: "my_integration"
    download_excludes:
      - "*.tmp"
      - "*.log"
    download_includes:
      - "*.sql"
      - "*.json"