Represents Temporal schedule client
Attributes
- See also
-
ScheduleClient
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Concrete methods
Create a schedule and return its handle.
Create a schedule and return its handle.
Value parameters
- options
-
Options for creating the schedule.
- schedule
-
Schedule to create.
- scheduleId
-
Unique ID for the schedule.
Attributes
- Returns
-
A handle that can be used to perform operations on a schedule.
- Throws
-
ScheduleAlreadyRunningException
if the schedule is already running.
Gets the schedule handle for the given ID.
Gets the schedule handle for the given ID.
Value parameters
- scheduleId
-
Schedule ID to get the handle for.
Attributes
- Returns
-
A handle that can be used to perform operations on a schedule.
List schedules.
List schedules.
Value parameters
- pageSize
-
how many results to fetch from the Server at a time. Optional, default is 100.
Attributes
- Returns
-
sequential stream that performs remote pagination under the hood
Creates new typed schedule start workflow stub builder. The instance could then be used to start a scheduled workflow.
Creates new typed schedule start workflow stub builder. The instance could then be used to start a scheduled workflow.
Type parameters
- A
-
workflow interface
Value parameters
- header
-
headers sent with each workflow scheduled
- options
-
options that will be used to configure and start a new workflow.
Attributes
- Returns
-
builder instance
Creates new untyped schedule start workflow stub builder. The instance could then be used to start a scheduled workflow.
Creates new untyped schedule start workflow stub builder. The instance could then be used to start a scheduled workflow.
Value parameters
- header
-
headers sent with each workflow scheduled
- options
-
options that will be used to configure and start a new workflow.
- workflowType
-
workflow type
Attributes
- Returns
-
builder instance