io.temporal.api.schedule.v1.SchedulePoliciesOrBuilder 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:SchedulePoliciesOrBuilder.java.pb.meta")
public interface SchedulePoliciesOrBuilder extends
    // @@protoc_insertion_point(interface_extends:temporal.api.schedule.v1.SchedulePolicies)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Policy for overlaps.
   * Note that this can be changed after a schedule has taken some actions,
   * and some changes might produce unintuitive results. In general, the later
   * policy overrides the earlier policy.
   * 
   *
   * .temporal.api.enums.v1.ScheduleOverlapPolicy overlap_policy = 1;
   * @return The enum numeric value on the wire for overlapPolicy.
   */
  int getOverlapPolicyValue();
  /**
   *    * Policy for overlaps.
   * Note that this can be changed after a schedule has taken some actions,
   * and some changes might produce unintuitive results. In general, the later
   * policy overrides the earlier policy.
   * 
   *
   * .temporal.api.enums.v1.ScheduleOverlapPolicy overlap_policy = 1;
   * @return The overlapPolicy.
   */
  io.temporal.api.enums.v1.ScheduleOverlapPolicy getOverlapPolicy();

  /**
   *    * Policy for catchups:
   * If the Temporal server misses an action due to one or more components
   * being down, and comes back up, the action will be run if the scheduled
   * time is within this window from the current time.
   * This value defaults to 60 seconds, and can't be less than 10 seconds.
   * 
   *
   * .google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];
   * @return Whether the catchupWindow field is set.
   */
  boolean hasCatchupWindow();
  /**
   *    * Policy for catchups:
   * If the Temporal server misses an action due to one or more components
   * being down, and comes back up, the action will be run if the scheduled
   * time is within this window from the current time.
   * This value defaults to 60 seconds, and can't be less than 10 seconds.
   * 
   *
   * .google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];
   * @return The catchupWindow.
   */
  com.google.protobuf.Duration getCatchupWindow();
  /**
   *    * Policy for catchups:
   * If the Temporal server misses an action due to one or more components
   * being down, and comes back up, the action will be run if the scheduled
   * time is within this window from the current time.
   * This value defaults to 60 seconds, and can't be less than 10 seconds.
   * 
   *
   * .google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];
   */
  com.google.protobuf.DurationOrBuilder getCatchupWindowOrBuilder();

  /**
   *    * If true, and a workflow run fails or times out, turn on "paused".
   * This applies after retry policies: the full chain of retries must fail to
   * trigger a pause here.
   * 
   *
   * bool pause_on_failure = 3;
   * @return The pauseOnFailure.
   */
  boolean getPauseOnFailure();
}