Package io.temporal.client.schedules

Interface ScheduleHandle

  • public interface ScheduleHandle
    Handle for interacting with a schedule.

    • Method Detail

      • getId

        java.lang.String getId()
        Get this schedule's ID.
        Returns:
        the schedule's ID

      • backfill

        void backfill​(java.util.List<ScheduleBackfill> backfills)
        Backfill this schedule by going through the specified time periods as if they passed right now.
        Parameters:
        backfills - backfill requests to run

      • delete

        void delete()
        Delete this schedule.

      • describe

        ScheduleDescription describe()
        Fetch this schedule's description.
        Returns:
        description of the schedule

      • pause

        void pause​(@Nonnull
           java.lang.String note)
        Pause this schedule.
        Parameters:
        note - to set the schedule state.

      • pause

        void pause()
        Pause this schedule.

      • trigger

        void trigger​(io.temporal.api.enums.v1.ScheduleOverlapPolicy overlapPolicy)
        Trigger an action on this schedule to happen immediately.
        Parameters:
        overlapPolicy - override the schedule overlap policy.

      • trigger

        void trigger()
        Trigger an action on this schedule to happen immediately.

      • unpause

        void unpause​(@Nonnull
             java.lang.String note)
        Unpause this schedule.
        Parameters:
        note - to set the schedule state.

      • unpause

        void unpause()
        Unpause this schedule.

      • update

        void update​(Functions.Func1<ScheduleUpdateInput,​ScheduleUpdate> updater)
        Update this schedule. This is done via a callback which can be called multiple times in case of conflict.
        Parameters:
        updater - Callback to invoke with the current update input. The result can be null to signify no update to perform, or a schedule update instance with a schedule to perform an update.