Package io.temporal.api.schedule.v1

Interface ScheduleInfoOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ScheduleInfo, ScheduleInfo.Builder
    @Generated(value="protoc",
           comments="annotations:ScheduleInfoOrBuilder.java.pb.meta")
public interface ScheduleInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getActionCount

        long getActionCount()
         Number of actions taken so far.
        int64 action_count = 1;
        Returns:
        The actionCount.

      • getMissedCatchupWindow

        long getMissedCatchupWindow()
         Number of times a scheduled action was skipped due to missing the catchup window.
        int64 missed_catchup_window = 2;
        Returns:
        The missedCatchupWindow.

      • getOverlapSkipped

        long getOverlapSkipped()
         Number of skipped actions due to overlap.
        int64 overlap_skipped = 3;
        Returns:
        The overlapSkipped.

      • getBufferDropped

        long getBufferDropped()
         Number of dropped actions due to buffer limit.
        int64 buffer_dropped = 10;
        Returns:
        The bufferDropped.

      • getBufferSize

        long getBufferSize()
         Number of actions in the buffer. The buffer holds the actions that cannot
 be immediately triggered (due to the overlap policy). These actions can be a result of
 the normal schedule or a backfill.
        int64 buffer_size = 11;
        Returns:
        The bufferSize.

      • getRunningWorkflowsList

        java.util.List<WorkflowExecution> getRunningWorkflowsList()
         Currently-running workflows started by this schedule. (There might be
 more than one if the overlap policy allows overlaps.)
 Note that the run_ids in here are the original execution run ids as
 started by the schedule. If the workflows retried, did continue-as-new,
 or were reset, they might still be running but with a different run_id.
        repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;

      • getRunningWorkflows

        WorkflowExecution getRunningWorkflows​(int index)
         Currently-running workflows started by this schedule. (There might be
 more than one if the overlap policy allows overlaps.)
 Note that the run_ids in here are the original execution run ids as
 started by the schedule. If the workflows retried, did continue-as-new,
 or were reset, they might still be running but with a different run_id.
        repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;

      • getRunningWorkflowsCount

        int getRunningWorkflowsCount()
         Currently-running workflows started by this schedule. (There might be
 more than one if the overlap policy allows overlaps.)
 Note that the run_ids in here are the original execution run ids as
 started by the schedule. If the workflows retried, did continue-as-new,
 or were reset, they might still be running but with a different run_id.
        repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;

      • getRunningWorkflowsOrBuilderList

        java.util.List<? extends WorkflowExecutionOrBuilder> getRunningWorkflowsOrBuilderList()
         Currently-running workflows started by this schedule. (There might be
 more than one if the overlap policy allows overlaps.)
 Note that the run_ids in here are the original execution run ids as
 started by the schedule. If the workflows retried, did continue-as-new,
 or were reset, they might still be running but with a different run_id.
        repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;

      • getRunningWorkflowsOrBuilder

        WorkflowExecutionOrBuilder getRunningWorkflowsOrBuilder​(int index)
         Currently-running workflows started by this schedule. (There might be
 more than one if the overlap policy allows overlaps.)
 Note that the run_ids in here are the original execution run ids as
 started by the schedule. If the workflows retried, did continue-as-new,
 or were reset, they might still be running but with a different run_id.
        repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;

      • getRecentActionsList

        java.util.List<ScheduleActionResult> getRecentActionsList()
         Most recent ten actual action times (including manual triggers).
        repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;

      • getRecentActions

        ScheduleActionResult getRecentActions​(int index)
         Most recent ten actual action times (including manual triggers).
        repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;

      • getRecentActionsCount

        int getRecentActionsCount()
         Most recent ten actual action times (including manual triggers).
        repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;

      • getRecentActionsOrBuilderList

        java.util.List<? extends ScheduleActionResultOrBuilder> getRecentActionsOrBuilderList()
         Most recent ten actual action times (including manual triggers).
        repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;

      • getRecentActionsOrBuilder

        ScheduleActionResultOrBuilder getRecentActionsOrBuilder​(int index)
         Most recent ten actual action times (including manual triggers).
        repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;

      • getFutureActionTimesList

        java.util.List<Timestamp> getFutureActionTimesList()
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;

      • getFutureActionTimes

        Timestamp getFutureActionTimes​(int index)
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;

      • getFutureActionTimesCount

        int getFutureActionTimesCount()
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;

      • getFutureActionTimesOrBuilderList

        java.util.List<? extends TimestampOrBuilder> getFutureActionTimesOrBuilderList()
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;

      • getFutureActionTimesOrBuilder

        TimestampOrBuilder getFutureActionTimesOrBuilder​(int index)
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;

      • hasCreateTime

        boolean hasCreateTime()
         Timestamps of schedule creation and last update.
        .google.protobuf.Timestamp create_time = 6;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        Timestamp getCreateTime()
         Timestamps of schedule creation and last update.
        .google.protobuf.Timestamp create_time = 6;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        TimestampOrBuilder getCreateTimeOrBuilder()
         Timestamps of schedule creation and last update.
        .google.protobuf.Timestamp create_time = 6;

      • hasUpdateTime

        boolean hasUpdateTime()
        .google.protobuf.Timestamp update_time = 7;
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        Timestamp getUpdateTime()
        .google.protobuf.Timestamp update_time = 7;
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        TimestampOrBuilder getUpdateTimeOrBuilder()
        .google.protobuf.Timestamp update_time = 7;

      • getInvalidScheduleError

        @Deprecated
java.lang.String getInvalidScheduleError()
        Deprecated.
        string invalid_schedule_error = 8 [deprecated = true];
        Returns:
        The invalidScheduleError.

      • getInvalidScheduleErrorBytes

        @Deprecated
com.google.protobuf.ByteString getInvalidScheduleErrorBytes()
        Deprecated.
        string invalid_schedule_error = 8 [deprecated = true];
        Returns:
        The bytes for invalidScheduleError.