TriggerSavepoint

Trigger a savepoint for a running Flink job.

This task triggers a savepoint for a running Flink job without canceling it. Savepoints are used to capture the state of a job for backup or migration purposes.

yaml
type: "io.kestra.plugin.flink.TriggerSavepoint"

Examples

Trigger savepoint with specific directory

yaml
id: create-savepoint
namespace: company.team

tasks:
  - id: trigger-savepoint
    type: io.kestra.plugin.flink.TriggerSavepoint
    restUrl: "http://flink-jobmanager:8081"
    jobId: "{{ inputs.jobId }}"
    targetDirectory: "s3://flink/savepoints/backup/{{ execution.id }}"
    savepointTimeout: 300

Trigger savepoint with default directory

yaml
id: "triggersavepoint"
type: "io.kestra.plugin.flink.TriggerSavepoint"
id: default-savepoint
type: io.kestra.plugin.flink.TriggerSavepoint
restUrl: "http://flink-jobmanager:8081"
jobId: "{{ inputs.jobId }}"

Properties

jobId *string

Job ID

The ID of the Flink job to create a savepoint for

restUrl *string

Flink REST API URL

The base URL of the Flink cluster's REST API, e.g., 'http://flink-jobmanager: 8081'

cancelJob booleanstring

Default false

Cancel job after savepoint

Whether to cancel the job after creating the savepoint. Defaults to false.

formatType string

Default CANONICAL

Format type

Format type of the savepoint. Can be 'CANONICAL' or 'NATIVE'. Defaults to 'CANONICAL' for better compatibility.

savepointTimeout integerstring

Default 300

Savepoint timeout

Maximum time to wait for savepoint creation in seconds. Defaults to 300.

targetDirectory string

Target directory

Target directory for the savepoint. If not specified, the cluster's default savepoint directory will be used.

Outputs

jobId string

The job ID

The ID of the Flink job for which the savepoint was created

requestId string

Request ID

The savepoint request ID

savepointPath string

Savepoint path

Path to the created savepoint

​Trigger​Savepoint

TriggerSavepoint