temporal.client.schedule — io.github.manetu/temporal-sdk 2.3.1

create-client clj

(create-client options)

(create-client options timeout)

Creates a ScheduleClient instance suitable for interacting with Temporal's Schedules.

Arguments:

• options: Options for configuring the ScheduleClient (See temporal.client.options/schedule-client-options and temporal.client.options/stub-options)
• timeout: Connection timeout as a Duration (default: 5s)

describe clj

(describe client schedule-id)

Describes an existing Temporal Schedule via a schedule-id

(let [client (create-client {:target "localhost:7233"})]
   (describe client "my-schedule")

execute clj

(execute client schedule-id overlap-policy)

Runs a Temporal Schedule workflow execution immediately via a schedule-id

(let [client (create-client {:target "localhost:7233"})]
   (execute client "my-schedule" :skip)

pause clj

(pause client schedule-id)

Pauses an existing Temporal Schedule via a schedule-id

(let [client (create-client {:target "localhost:7233"})]
   (pause client "my-schedule")

reschedule clj

(reschedule client schedule-id options)

Updates the current Temporal Schedule via a schedule-id. Uses the same options as schedule except :schedule.

The ScheduleHandle takes a unary function object of the signature:

(ScheduleUpdateInput) -> ScheduleUpdate

(let [client (create-client {:target "localhost:7233"})]
   (reschedule client "my-schedule" {:spec {:cron-expressions ["1 * * * *"]}})

schedule clj

(schedule client schedule-id options)

Creates a Schedule with Temporal

Arguments:

• client: ScheduleClient
• schedule-id: The string name of the schedule in Temporal, keeping it consistent with workflow id is a good idea
• options: A map containing the :schedule, :state, :policy, :spec, and :action option maps for the Schedule

:schedule options:

Value	Description	Type
:trigger-immediately?	Trigger one action immediately when the schedule is created	boolean
:memo	Arbitrary non-indexed metadata map	Map
:search-attributes	Indexed schedule-level attributes. Supports simple and typed formats; see Search attribute input formats.	Map

:state options:

Value	Description	Type
:paused?	Whether the schedule starts paused	boolean
:note	Human-readable note describing the current state	String
:limited-action?	Limit the schedule to :remaining-actions executions	boolean
:remaining-actions	Number of actions remaining when :limited-action? is set	long

:policy options:

Value	Description	Type
:overlap	Overlap policy: :allow, :buffer, :buffer-one, :cancel, :skip, :terminate	keyword
:catchup-window	Maximum catch-up window for missed actions	Duration
:pause-on-failure?	Pause the schedule if a workflow action fails	boolean

:spec options:

Value	Description	Type
:cron-expressions	Cron expressions in Temporal cron syntax	List of String
:calendars	Calendar specs	List of ScheduleCalendarSpec
:intervals	Interval specs	List of ScheduleIntervalSpec
:start-at	Time before which no actions are taken	Instant
:end-at	Time after which no actions are taken	Instant
:jitter	Random jitter applied to each action time	Duration
:skip-at	Calendar specs to skip	List of ScheduleCalendarSpec
:timezone	IANA timezone name (e.g. US/Central, UTC); one of ZoneId/getAvailableZoneIds	String

:action options:

Value	Description	Type
:workflow-type	The workflow to start	A temporal.workflow/defworkflow reference or its String name
:arguments	Arguments passed to the started workflow	Serializable value
:options	Workflow options for each started run	See temporal.client.core/create-workflow

:search-attributes is supported in both :schedule and :action :options. Both simple and typed formats are accepted; see Search attribute input formats.

(defworkflow my-workflow
  [args]
  ...)

(let [client (create-client {:target "localhost:7233"})]
  (schedule
   client
   "my-workflow-schedule"
   {:schedule {:trigger-immediately? false
               :search-attributes {"ScheduleType" {:type :keyword :value "hourly"}}}
    :state {:paused? false}
    :policy {:pause-on-failure? true}
    :spec {:cron-expressions ["0 * * * *"]}
    :action {:workflow-type my-workflow
             :arguments {:value 1}
             :options {:workflow-id "my-workflow"
                       :task-queue "my-task-queue"
                       :search-attributes {"WorkflowType" {:type :keyword :value "report"}}}}}))

unpause clj

(unpause client schedule-id)

Unpauses an existing Temporal Schedule via a schedule-id

(let [client (create-client {:target "localhost:7233"})]
   (unpause client "my-schedule")

unschedule clj

(unschedule client schedule-id)

Deletes a Temporal Schedule via a schedule-id

(let [client (create-client {:target "localhost:7233"})]
  (unschedule client "my-schedule")