Google Cloud Storage (GCS) Downloads

Google Cloud Storage (GCS) Downloads

Certified

Download multiple GCS objects

Lists objects under a prefix (with optional regex and versioning) then downloads them to Kestra storage. Can MOVE (copy then delete) or DELETE source objects after download.

yaml
type: io.kestra.plugin.gcp.gcs.Downloads

Download a list of files and move it to an archive folders

yaml
id: gcp_gcs_downloads
namespace: company.team

tasks:
  - id: downloads
    type: io.kestra.plugin.gcp.gcs.Downloads
    from: gs://my-bucket/kestra/files/
    action: MOVE
    moveDirectory: gs://my-bucket/kestra/archive/

Download a list of files with end-to-end checksum validation

yaml
id: gcp_gcs_downloads_validated
namespace: company.team

tasks:
  - id: downloads
    type: io.kestra.plugin.gcp.gcs.Downloads
    from: gs://my-bucket/kestra/files/
    action: DELETE
    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

Source prefix

gs:// bucket path to list and download from

DefaultNONE
Possible Values
MOVEDELETENONE

Post-download action

NONE (default), DELETE, or MOVE (copy to moveDirectory then delete source)

If set to true, lists all versions of a blob. The default is false

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

The GCP service account to impersonate

DefaultDIRECTORY
Possible Values
RECURSIVEDIRECTORY

Listing type

DIRECTORY lists only immediate children; RECURSIVE traverses all descendants. Default DIRECTORY.

Default25

Max files

Maximum number of files to list and download

Move destination

Required when action is MOVE; gs:// prefix for moved objects

The GCP project ID

Regex filter

Optional regex applied to object names

SubTypestring
Default["https://www.googleapis.com/auth/cloud-platform"]

The GCP scopes to be used

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).

Defaultfalse

Validate each downloaded file against the GCS checksum

When true, every downloaded 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 any file mismatches, the task fails. Used for end-to-end integrity, not for security/authentication.

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.

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.

Downloaded objects

Definitions
bucketstring
cacheControlstring
componentCountinteger
contentDispositionstring
contentEncodingstring
contentLanguagestring
contentTypestring
crc32cstring
createTimestring
Formatdate-time
customTimestring
Formatdate-time
deleteTimestring
Formatdate-time
etagstring
eventBasedHoldboolean
generatedIdstring
isDirectoryboolean
kmsKeyNamestring
md5string
mediaLinkstring
metaGenerationinteger
metadataobject
SubTypestring
namestring
retentionExpirationTimeinteger
selfLinkstring
sizeinteger
temporaryHoldboolean
timeStorageClassUpdatedstring
Formatdate-time
updateTimestring
Formatdate-time
uristring
Formaturi
SubTypestring

Downloaded file map

Map of object names to Kestra storage URIs

Number of files whose checksum was successfully validated after download.