Class SchedulePolicy

java.lang.Object

io.temporal.client.schedules.SchedulePolicy

public final class SchedulePolicy
extends Object

Policies of a schedule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SchedulePolicy.Builder

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Duration	getCatchupWindow()	Gets the amount of time in the past to execute missed actions after a Temporal server is unavailable.
io.temporal.api.enums.v1.ScheduleOverlapPolicy	getOverlap()	Gets the policy for what happens when an action is started while another is still running.
int	hashCode()
boolean	isPauseOnFailure()	Gets a value indicating whether to pause the schedule if an action fails or times out.
static SchedulePolicy.Builder	newBuilder()
static SchedulePolicy.Builder	newBuilder(SchedulePolicy options)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public static SchedulePolicy.Builder newBuilder()

newBuilder

public static SchedulePolicy.Builder newBuilder(SchedulePolicy options)

getOverlap

public io.temporal.api.enums.v1.ScheduleOverlapPolicy getOverlap()

Gets the policy for what happens when an action is started while another is still running.

Returns:

the schedules overlap policy

getCatchupWindow

public Duration getCatchupWindow()

Gets the amount of time in the past to execute missed actions after a Temporal server is unavailable.

Returns:

the schedules catchup window

isPauseOnFailure

public boolean isPauseOnFailure()

Gets a value indicating whether to pause the schedule if an action fails or times out.

Returns:

if the schedule should pause on failure

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object