Google Cloud Storage (GCS) Copy

Google Cloud Storage (GCS) Copy

Certified

Copy an object between GCS buckets

Copies an object to a destination path; optionally deletes the source after a successful copy.

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

Move a file between bucket path

yaml
id: gcp_gcs_copy
namespace: company.team

tasks:
  - id: copy
    type: io.kestra.plugin.gcp.gcs.Copy
    from: "gs://my_bucket/dir/file.csv"
    to: "gs://my_bucket/archive/file.csv"
    delete: true
Properties

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
Defaultfalse

Delete source on success

If true, removes the source object after a successful copy; default false

Source object URI

Fully qualified gs:// URI or an internal storage URI. Special characters and partition brackets are automatically percent-encoded if unencoded.

The GCP service account to impersonate

The GCP project ID

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

The GCP scopes to be used

The GCP service account

Destination object URI

Fully qualified gs:// path to copy to

Formaturi

Destination URI

Final gs:// URI of the copied object

Unitbytes

Size of the copied file.