Jobs.Cancel

func (*JobClient) Cancel(ctx context.Context, jobID uuid.UUID) error

Copy

Cancel a job. When a job is canceled, no queued tasks will be picked up by runners and executed even if runners are idle. Tasks that are already being executed will finish their execution and not be interrupted. All sub-tasks spawned from such tasks after the cancellation will not be picked up by runners.

Parameters

jobID uuid.UUID

The id of the job

Returns

An error if the job could not be cancelled.

Request example

Go

err := client.Jobs.Cancel(ctx,
    uuid.MustParse("0195c87a-49f6-5ffa-e3cb-92215d057ea6"),
)

Copy