Class ScheduleTaskBuilder

constructor

• new ScheduleTaskBuilder(): ScheduleTaskBuilder

• Returns ScheduleTaskBuilder

action

continue_on_failure

payload

time_offset

setAction

• setAction(action): ScheduleTaskBuilder

• Sets the action type for the task.

  Parameters

  • action: ScheduleActionType

    The action type.

  Returns ScheduleTaskBuilder

setContinueOnFailure

• setContinueOnFailure(continueOnFailure): ScheduleTaskBuilder

• Sets whether the task should continue even if it fails.

  Parameters

  • continueOnFailure: boolean

    Whether the task should continue even if it fails.

  Returns ScheduleTaskBuilder

setPayload

• setPayload(payload): ScheduleTaskBuilder

• Sets the payload for the task.

  Depending on the action type the payload is

  • the command that will be executed (e.g. "say Hello World!")
  • a SERVER_SIGNAL (e.g. SERVER_SIGNAL.START)
  • a list of ignored files for a backup (e.g. cache, logs)

  ---

  Parameters

  • payload: string

    The payload for the task.

  Returns ScheduleTaskBuilder

setTimeOffset

• setTimeOffset(timeOffset): ScheduleTaskBuilder

• Sets the time offset for the task.

  Parameters

  • timeOffset: number

    The time offset for the task.

  Returns ScheduleTaskBuilder