Package io.temporal.api.schedule.v1

Class ScheduleInfo

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ScheduleInfoOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:ScheduleInfo.java.pb.meta")
public final class ScheduleInfo
extends com.google.protobuf.GeneratedMessageV3
implements ScheduleInfoOrBuilder
    Protobuf type temporal.api.schedule.v1.ScheduleInfo
    See Also:
    Serialized Form

    • Field Detail

      • ACTION_COUNT_FIELD_NUMBER

        public static final int ACTION_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MISSED_CATCHUP_WINDOW_FIELD_NUMBER

        public static final int MISSED_CATCHUP_WINDOW_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OVERLAP_SKIPPED_FIELD_NUMBER

        public static final int OVERLAP_SKIPPED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUFFER_DROPPED_FIELD_NUMBER

        public static final int BUFFER_DROPPED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUFFER_SIZE_FIELD_NUMBER

        public static final int BUFFER_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUNNING_WORKFLOWS_FIELD_NUMBER

        public static final int RUNNING_WORKFLOWS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RECENT_ACTIONS_FIELD_NUMBER

        public static final int RECENT_ACTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FUTURE_ACTION_TIMES_FIELD_NUMBER

        public static final int FUTURE_ACTION_TIMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INVALID_SCHEDULE_ERROR_FIELD_NUMBER

        public static final int INVALID_SCHEDULE_ERROR_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getActionCount

        public long getActionCount()
         Number of actions taken so far.
        int64 action_count = 1;
        Specified by:
        getActionCount in interface ScheduleInfoOrBuilder
        Returns:
        The actionCount.

      • getMissedCatchupWindow

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

      • getOverlapSkipped

        public long getOverlapSkipped()
         Number of skipped actions due to overlap.
        int64 overlap_skipped = 3;
        Specified by:
        getOverlapSkipped in interface ScheduleInfoOrBuilder
        Returns:
        The overlapSkipped.

      • getBufferDropped

        public long getBufferDropped()
         Number of dropped actions due to buffer limit.
        int64 buffer_dropped = 10;
        Specified by:
        getBufferDropped in interface ScheduleInfoOrBuilder
        Returns:
        The bufferDropped.

      • getBufferSize

        public 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;
        Specified by:
        getBufferSize in interface ScheduleInfoOrBuilder
        Returns:
        The bufferSize.

      • getRunningWorkflowsList

        public 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;
        Specified by:
        getRunningWorkflowsList in interface ScheduleInfoOrBuilder

      • getRunningWorkflowsOrBuilderList

        public 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;
        Specified by:
        getRunningWorkflowsOrBuilderList in interface ScheduleInfoOrBuilder

      • getRunningWorkflowsCount

        public 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;
        Specified by:
        getRunningWorkflowsCount in interface ScheduleInfoOrBuilder

      • getRunningWorkflows

        public 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;
        Specified by:
        getRunningWorkflows in interface ScheduleInfoOrBuilder

      • getRunningWorkflowsOrBuilder

        public 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;
        Specified by:
        getRunningWorkflowsOrBuilder in interface ScheduleInfoOrBuilder

      • getRecentActionsCount

        public int getRecentActionsCount()
         Most recent ten actual action times (including manual triggers).
        repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;
        Specified by:
        getRecentActionsCount in interface ScheduleInfoOrBuilder

      • getRecentActions

        public ScheduleActionResult getRecentActions​(int index)
         Most recent ten actual action times (including manual triggers).
        repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;
        Specified by:
        getRecentActions in interface ScheduleInfoOrBuilder

      • getFutureActionTimesList

        public java.util.List<com.google.protobuf.Timestamp> getFutureActionTimesList()
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;
        Specified by:
        getFutureActionTimesList in interface ScheduleInfoOrBuilder

      • getFutureActionTimesOrBuilderList

        public java.util.List<? extends com.google.protobuf.TimestampOrBuilder> getFutureActionTimesOrBuilderList()
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;
        Specified by:
        getFutureActionTimesOrBuilderList in interface ScheduleInfoOrBuilder

      • getFutureActionTimesCount

        public int getFutureActionTimesCount()
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;
        Specified by:
        getFutureActionTimesCount in interface ScheduleInfoOrBuilder

      • getFutureActionTimes

        public com.google.protobuf.Timestamp getFutureActionTimes​(int index)
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;
        Specified by:
        getFutureActionTimes in interface ScheduleInfoOrBuilder

      • getFutureActionTimesOrBuilder

        public com.google.protobuf.TimestampOrBuilder getFutureActionTimesOrBuilder​(int index)
         Next ten scheduled action times.
        repeated .google.protobuf.Timestamp future_action_times = 5;
        Specified by:
        getFutureActionTimesOrBuilder in interface ScheduleInfoOrBuilder

      • hasCreateTime

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

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Timestamps of schedule creation and last update.
        .google.protobuf.Timestamp create_time = 6;
        Specified by:
        getCreateTime in interface ScheduleInfoOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Timestamps of schedule creation and last update.
        .google.protobuf.Timestamp create_time = 6;
        Specified by:
        getCreateTimeOrBuilder in interface ScheduleInfoOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
        .google.protobuf.Timestamp update_time = 7;
        Specified by:
        hasUpdateTime in interface ScheduleInfoOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
        .google.protobuf.Timestamp update_time = 7;
        Specified by:
        getUpdateTime in interface ScheduleInfoOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
        .google.protobuf.Timestamp update_time = 7;
        Specified by:
        getUpdateTimeOrBuilder in interface ScheduleInfoOrBuilder

      • getInvalidScheduleError

        @Deprecated
public java.lang.String getInvalidScheduleError()
        Deprecated.
        string invalid_schedule_error = 8 [deprecated = true];
        Specified by:
        getInvalidScheduleError in interface ScheduleInfoOrBuilder
        Returns:
        The invalidScheduleError.

      • getInvalidScheduleErrorBytes

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ScheduleInfo parseFrom​(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScheduleInfo parseFrom​(java.nio.ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScheduleInfo parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScheduleInfo parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScheduleInfo parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScheduleInfo parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScheduleInfo parseFrom​(java.io.InputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ScheduleInfo parseFrom​(java.io.InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ScheduleInfo parseDelimitedFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ScheduleInfo parseDelimitedFrom​(java.io.InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ScheduleInfo parseFrom​(com.google.protobuf.CodedInputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ScheduleInfo parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public ScheduleInfo.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ScheduleInfo.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ScheduleInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ScheduleInfo getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ScheduleInfo> parser()

      • getParserForType

        public com.google.protobuf.Parser<ScheduleInfo> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ScheduleInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder