temporalio.client.ScheduleHandle
| 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 |
Backfill the schedule by going through the specified time periods as if they passed right now.
| Parameters | |
*backfill:ScheduleBackfill | Backfill periods. |
rpcMapping[ | Headers used on the RPC call. Keys here override client-level RPC metadata keys. |
rpctimedelta | None | Optional RPC deadline to set for the RPC call. |
Delete this schedule.
| Parameters | |
rpcMapping[ | Headers used on the RPC call. Keys here override client-level RPC metadata keys. |
rpctimedelta | None | Optional RPC deadline to set for the RPC call. |
Fetch this schedule's description.
| Parameters | |
rpcMapping[ | Headers used on the RPC call. Keys here override client-level RPC metadata keys. |
rpctimedelta | None | Optional RPC deadline to set for the RPC call. |
Pause the schedule and set a note.
| Parameters | |
note:str | None | Note to set on the schedule. |
rpcMapping[ | Headers used on the RPC call. Keys here override client-level RPC metadata keys. |
rpctimedelta | None | Optional RPC deadline to set for the RPC call. |
Trigger an action on this schedule to happen immediately.
| Parameters | |
overlap:ScheduleOverlapPolicy | None | If set, overrides the schedule's overlap policy. |
rpcMapping[ | Headers used on the RPC call. Keys here override client-level RPC metadata keys. |
rpctimedelta | None | Optional RPC deadline to set for the RPC call. |
Unpause the schedule and set a note.
| Parameters | |
note:str | None | Note to set on the schedule. |
rpcMapping[ | Headers used on the RPC call. Keys here override client-level RPC metadata keys. |
rpctimedelta | None | Optional RPC deadline to set for the RPC call. |
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.