Google Cloud CancelJob

Google Cloud CancelJob

Certified

Cancel or drain a running Dataflow job

Requests a transition to JOB_STATE_CANCELLED to cancel immediately, or JOB_STATE_DRAINING to allow streaming pipelines to process in-flight data before stopping.

yaml
type: io.kestra.plugin.gcp.dataflow.CancelJob

Cancel a Dataflow job.

yaml
id: cancel_dataflow_job
namespace: company.team

tasks:
  - id: cancel
    type: io.kestra.plugin.gcp.dataflow.CancelJob
    projectId: "{{ secret('GCP_PROJECT_ID') }}"
    location: us-central1
    jobId: 2026-06-25_00_00_00-123456789
    drain: false
Properties

The Dataflow job ID

The regional endpoint (e.g. us-central1)

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

Whether to drain the job instead of cancelling it

Draining allows in-flight data processing to finish (only applicable to streaming jobs).

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

The current state of the job

The job ID