SchedulePolicy (temporal-sdk 1.23.1 API)

java.lang.Object
- io.temporal.client.schedules.SchedulePolicy

public final class SchedulePolicy
extends java.lang.Object

Policies of a schedule.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SchedulePolicy.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.time.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)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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 java.time.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(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object