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

Modifier and Type	Method	Description
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.
com.google.protobuf.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.
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 60 seconds, and can't be less than 10 seconds.
 

.google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];

Returns:

Whether the catchupWindow field is set.

getCatchupWindow

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];

Returns:

The catchupWindow.

getCatchupWindowOrBuilder

com.google.protobuf.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 60 seconds, and can't be less than 10 seconds.
 

.google.protobuf.Duration catchup_window = 2 [(.gogoproto.stdduration) = true];

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.