temporalio.client.ScheduleOverlapPolicy

class documentation

class ScheduleOverlapPolicy(IntEnum): (source)

Controls what happens when a workflow would be started by a schedule but one is already running.

Constant	`ALLOW_ALL`	Start any number of concurrent workflows.
Constant	`BUFFER_ALL`	Buffer up any number of starts to all happen sequentially, immediately after the running workflow completes.
Constant	`BUFFER_ONE`	Start the workflow again soon as the current one completes, but only buffer one start in this way.
Constant	`CANCEL_OTHER`	If there is another workflow running, cancel it, and start the new one after the old one completes cancellation.
Constant	`SKIP`	Don't start anything.
Constant	`TERMINATE_OTHER`	If there is another workflow running, terminate it and start the new one immediately.

ALLOW_ALL = (source) ¶

Start any number of concurrent workflows.

Note that with this policy, last completion result and last failure will not be available since workflows are not sequential.

Value

int(temporalio.api.enums.v1.ScheduleOverlapPolicy.SCHEDULE_OVERLAP_POLICY_ALLOW_ALL↵
)

BUFFER_ALL = (source) ¶

Buffer up any number of starts to all happen sequentially, immediately after the running workflow completes.

Value

int(temporalio.api.enums.v1.ScheduleOverlapPolicy.SCHEDULE_OVERLAP_POLICY_BUFFER_ALL↵
)

BUFFER_ONE = (source) ¶

Start the workflow again soon as the current one completes, but only buffer one start in this way.

If another start is supposed to happen when the workflow is running, and one is already buffered, then only the first one will be started after the running workflow finishes.

Value

int(temporalio.api.enums.v1.ScheduleOverlapPolicy.SCHEDULE_OVERLAP_POLICY_BUFFER_ONE↵
)

CANCEL_OTHER = (source) ¶

If there is another workflow running, cancel it, and start the new one after the old one completes cancellation.

Value

int(temporalio.api.enums.v1.ScheduleOverlapPolicy.SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER↵
)

SKIP = (source) ¶

Don't start anything.

When the workflow completes, the next scheduled event after that time will be considered.

Value

int(temporalio.api.enums.v1.ScheduleOverlapPolicy.SCHEDULE_OVERLAP_POLICY_SKIP)

TERMINATE_OTHER = (source) ¶

If there is another workflow running, terminate it and start the new one immediately.

Value

int(temporalio.api.enums.v1.ScheduleOverlapPolicy.SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER↵
)