Package io.temporal.api.schedule.v1

Interface ScheduleStateOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getLimitedActions()
      If limited_actions is true, decrement remaining_actions after each action, and do not take any more scheduled actions if remaining_actions is zero.
      java.lang.String getNotes()
      Informative human-readable message with contextual notes, e.g.
      com.google.protobuf.ByteString getNotesBytes()
      Informative human-readable message with contextual notes, e.g.
      boolean getPaused()
      If true, do not take any actions based on the schedule spec.
      long getRemainingActions()
      int64 remaining_actions = 4;

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getNotes

        java.lang.String getNotes()
         Informative human-readable message with contextual notes, e.g. the reason
 a schedule is paused. The system may overwrite this message on certain
 conditions, e.g. when pause-on-failure happens.
        string notes = 1;
        Returns:
        The notes.

      • getNotesBytes

        com.google.protobuf.ByteString getNotesBytes()
         Informative human-readable message with contextual notes, e.g. the reason
 a schedule is paused. The system may overwrite this message on certain
 conditions, e.g. when pause-on-failure happens.
        string notes = 1;
        Returns:
        The bytes for notes.

      • getPaused

        boolean getPaused()
         If true, do not take any actions based on the schedule spec.
        bool paused = 2;
        Returns:
        The paused.

      • getLimitedActions

        boolean getLimitedActions()
         If limited_actions is true, decrement remaining_actions after each
 action, and do not take any more scheduled actions if remaining_actions
 is zero. Actions may still be taken by explicit request (i.e. trigger
 immediately or backfill). Skipped actions (due to overlap policy) do not
 count against remaining actions.
        bool limited_actions = 3;
        Returns:
        The limitedActions.

      • getRemainingActions

        long getRemainingActions()
        int64 remaining_actions = 4;
        Returns:
        The remainingActions.