io.temporal.api.schedule.v1.ScheduleStateOrBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of temporal-serviceclient Show documentation

Temporal Workflow Java SDK

There is a newer version: 1.27.0

Show newest version

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: temporal/api/schedule/v1/message.proto

package io.temporal.api.schedule.v1;

@javax.annotation.Generated(value="protoc", comments="annotations:ScheduleStateOrBuilder.java.pb.meta")
public interface ScheduleStateOrBuilder extends
    // @@protoc_insertion_point(interface_extends:temporal.api.schedule.v1.ScheduleState)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   * @return The notes.
   */
  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;
   * @return The bytes for notes.
   */
  com.google.protobuf.ByteString
      getNotesBytes();

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

  /**
   *    * 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;
   * @return The limitedActions.
   */
  boolean getLimitedActions();

  /**
   * int64 remaining_actions = 4;
   * @return The remainingActions.
   */
  long getRemainingActions();
}