temporalio.client.ScheduleHandle

temporalio.client.ScheduleHandle

class documentation

class ScheduleHandle: (source)

Constructor: ScheduleHandle(client, id)

View In Hierarchy

Handle for interacting with a schedule.

This is usually created via Client.get_schedule_handle or returned from Client.create_schedule.

Method __init__ Create schedule handle.
Async Method backfill Backfill the schedule by going through the specified time periods as if they passed right now.
Async Method delete Delete this schedule.
Async Method describe Fetch this schedule's description.
Async Method pause Pause the schedule and set a note.
Async Method trigger Trigger an action on this schedule to happen immediately.
Async Method unpause Unpause the schedule and set a note.
Async Method update Update a schedule using a callback to build the update from the description.
Instance Variable id ID of the schedule.
Instance Variable _client Undocumented
def __init__(self, client: Client, id: str): (source)

Create schedule handle.

async def backfill(self, *backfill: ScheduleBackfill, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None): (source)

Backfill the schedule by going through the specified time periods as if they passed right now.

Parameters
*backfill:ScheduleBackfillBackfill periods.
rpc_metadata:Mapping[str, str | bytes]Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:timedelta | NoneOptional RPC deadline to set for the RPC call.
async def delete(self, *, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None): (source)

Delete this schedule.

Parameters
rpc_metadata:Mapping[str, str | bytes]Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:timedelta | NoneOptional RPC deadline to set for the RPC call.
async def describe(self, *, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None) -> ScheduleDescription: (source)

Fetch this schedule's description.

Parameters
rpc_metadata:Mapping[str, str | bytes]Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:timedelta | NoneOptional RPC deadline to set for the RPC call.
Returns
ScheduleDescriptionUndocumented
async def pause(self, *, note: str | None = None, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None): (source)

Pause the schedule and set a note.

Parameters
note:str | NoneNote to set on the schedule.
rpc_metadata:Mapping[str, str | bytes]Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:timedelta | NoneOptional RPC deadline to set for the RPC call.
async def trigger(self, *, overlap: ScheduleOverlapPolicy | None = None, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None): (source)

Trigger an action on this schedule to happen immediately.

Parameters
overlap:ScheduleOverlapPolicy | NoneIf set, overrides the schedule's overlap policy.
rpc_metadata:Mapping[str, str | bytes]Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:timedelta | NoneOptional RPC deadline to set for the RPC call.
async def unpause(self, *, note: str | None = None, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None): (source)

Unpause the schedule and set a note.

Parameters
note:str | NoneNote to set on the schedule.
rpc_metadata:Mapping[str, str | bytes]Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:timedelta | NoneOptional RPC deadline to set for the RPC call.
@overload
async def update(self, updater: Callable[[ScheduleUpdateInput], ScheduleUpdate | None], *, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None):
@overload
async def update(self, updater: Callable[[ScheduleUpdateInput], Awaitable[ScheduleUpdate | None]], *, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None):
(source)

Update a schedule using a callback to build the update from the description.

The callback may be invoked multiple times in a conflict-resolution loop.

id = (source)

ID of the schedule.

_client = (source)

Undocumented