Skip to main content

ScheduleService

Source and message fields. Error family: operations.

GetSchedule​

Reads a schedule even if its service has no running instances.

  • Path: /backplane.console.v1.ScheduleService/GetSchedule.
  • Input: GetScheduleRequest; output: GetScheduleResponse; mode: unary.
  • Errors: operations + common.
  • Read/validation: safe to retry after a transient failure.
// client: ScheduleServiceClient; request: GetScheduleRequest; signal: AbortSignal
const response = await client.getSchedule(request, { signal });

CreateSchedule​

Creates for a declared workflow; duplicate id: ALREADY_EXISTS.

  • Path: /backplane.console.v1.ScheduleService/CreateSchedule.
  • Input: CreateScheduleRequest; output: CreateScheduleResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: ScheduleServiceClient; request: CreateScheduleRequest; signal: AbortSignal
const response = await client.createSchedule(request, { signal });

UpdateSchedule​

Optimistic update using GetSchedule revision; conflict: ABORTED. Operator pause, note and execution counters are always preserved.

  • Path: /backplane.console.v1.ScheduleService/UpdateSchedule.
  • Input: UpdateScheduleRequest; output: UpdateScheduleResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: ScheduleServiceClient; request: UpdateScheduleRequest; signal: AbortSignal
const response = await client.updateSchedule(request, { signal });

DeleteSchedule​

Deletes the schedule, leaving existing workflow runs intact.

  • Path: /backplane.console.v1.ScheduleService/DeleteSchedule.
  • Input: DeleteScheduleRequest; output: DeleteScheduleResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: ScheduleServiceClient; request: DeleteScheduleRequest; signal: AbortSignal
const response = await client.deleteSchedule(request, { signal });

ListSchedules​

Schedules stored in Temporal under a service prefix, including services no longer present in the registry. Legacy declarations are annotations.

  • Path: /backplane.console.v1.ScheduleService/ListSchedules.
  • Input: ListSchedulesRequest; output: ListSchedulesResponse; mode: unary.
  • Errors: operations + common.
  • Read/validation: safe to retry after a transient failure.
// client: ScheduleServiceClient; request: ListSchedulesRequest; signal: AbortSignal
const response = await client.listSchedules(request, { signal });

PauseSchedule​

PauseSchedule is a unary operation.

  • Path: /backplane.console.v1.ScheduleService/PauseSchedule.
  • Input: PauseScheduleRequest; output: PauseScheduleResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: ScheduleServiceClient; request: PauseScheduleRequest; signal: AbortSignal
const response = await client.pauseSchedule(request, { signal });

UnpauseSchedule​

UnpauseSchedule is a unary operation.

  • Path: /backplane.console.v1.ScheduleService/UnpauseSchedule.
  • Input: UnpauseScheduleRequest; output: UnpauseScheduleResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: ScheduleServiceClient; request: UnpauseScheduleRequest; signal: AbortSignal
const response = await client.unpauseSchedule(request, { signal });

TriggerSchedule​

Starts the schedule's action now, whatever its overlap policy. The run carries the schedule's action (memo included): Temporal takes no memo on a trigger, so who triggered it is in the audit, not on the run.

  • Path: /backplane.console.v1.ScheduleService/TriggerSchedule.
  • Input: TriggerScheduleRequest; output: TriggerScheduleResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: ScheduleServiceClient; request: TriggerScheduleRequest; signal: AbortSignal
const response = await client.triggerSchedule(request, { signal });