Package io.temporal.api.schedule.v1

Interface SchedulePoliciesOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      DurationOrBuilder getCatchupWindowOrBuilder()
      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.
      boolean getKeepOriginalWorkflowId()
      If true, and the action would start a workflow, a timestamp will not be appended to the scheduled workflow id.
      ScheduleOverlapPolicy getOverlapPolicy()
      Policy for overlaps.
      int getOverlapPolicyValue()
      Policy for overlaps.
      boolean getPauseOnFailure()
      If true, and a workflow run fails or times out, turn on "paused".
      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.

      • 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

      • getOverlapPolicyValue

        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;
        Returns:
        The enum numeric value on the wire for overlapPolicy.

      • getOverlapPolicy

        ScheduleOverlapPolicy getOverlapPolicy()
         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;
        Returns:
        The overlapPolicy.

      • hasCatchupWindow

        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 one year, and can't be less than 10 seconds.
        .google.protobuf.Duration catchup_window = 2;
        Returns:
        Whether the catchupWindow field is set.

      • getCatchupWindow

        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 one year, and can't be less than 10 seconds.
        .google.protobuf.Duration catchup_window = 2;
        Returns:
        The catchupWindow.

      • getCatchupWindowOrBuilder

        DurationOrBuilder getCatchupWindowOrBuilder()
         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 one year, and can't be less than 10 seconds.
        .google.protobuf.Duration catchup_window = 2;

      • getPauseOnFailure

        boolean getPauseOnFailure()
         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;
        Returns:
        The pauseOnFailure.

      • getKeepOriginalWorkflowId

        boolean getKeepOriginalWorkflowId()
         If true, and the action would start a workflow, a timestamp will not be
 appended to the scheduled workflow id.
        bool keep_original_workflow_id = 4;
        Returns:
        The keepOriginalWorkflowId.