Google Cloud Storage (GCS) Download
Certified
Download a GCS object
Google Cloud Storage (GCS) Download
Download a GCS object
Reads a gs:// object to a temp file and stores it in Kestra internal storage. Optionally validates the file integrity by recomputing its checksum locally and comparing it to the value stored in GCS.
type: io.kestra.plugin.gcp.gcs.DownloadExamples
id: gcp_gcs_download
namespace: company.team
tasks:
- id: download
type: io.kestra.plugin.gcp.gcs.Download
from: "gs://my_bucket/dir/file.csv"
Download with end-to-end checksum validation
id: gcp_gcs_download_validated
namespace: company.team
tasks:
- id: download
type: io.kestra.plugin.gcp.gcs.Download
from: "gs://my_bucket/dir/file.csv"
validateChecksum: true
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-gcp --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
Properties
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150from string
Source object URI
gs:// URI of the object to download. Special characters and partition brackets are automatically percent-encoded if unencoded.
impersonatedServiceAccount string
The GCP service account to impersonate
projectId string
The GCP project ID
scopes array
["https://www.googleapis.com/auth/cloud-platform"]The GCP scopes to be used
serviceAccount string
The GCP service account
When unset or rendered to an empty value, Application Default Credentials are used (e.g. GOOGLE_APPLICATION_CREDENTIALS or the runtime's attached identity).
validateChecksum booleanstring
falseValidate the downloaded file against the GCS checksum
When true, the file is streamed through a CRC32C hasher (or MD5 if the object has no CRC32C) and compared to the checksum reported by Google Cloud Storage. If the values differ, the task fails and the temporary file is deleted. Used for end-to-end integrity, not for security/authentication.
workloadIdentityAudience string
Audience of the Workload Identity Federation provider
The full resource name of the workload identity pool provider, //iam.googleapis.com/projects/<number>/locations/global/workloadIdentityPools/<pool>/providers/<provider>.
Required with workloadIdentityToken, and must match the aud claim of the token.
workloadIdentityToken string
OIDC token for Workload Identity Federation
When set together with workloadIdentityAudience, the token is exchanged at Google STS for federated credentials and no service account key is needed: Google verifies it against the identity provider that issued it.
Use {{ oidcToken(audience='…') }} to have Kestra Enterprise mint one for the running execution.
Combine with impersonatedServiceAccount to act as a service account the pool may impersonate, and set projectId explicitly since no key file carries it.
Cannot be combined with serviceAccount.
Outputs
bucket string
Bucket
path string
Object path
uri string
uriKestra storage URI
Internal storage URI where the file was saved
Metrics
checksum.validated counter
Number of files whose checksum was successfully validated after download.