Class ScheduleOptions

java.lang.Object

io.temporal.client.schedules.ScheduleOptions

public final class ScheduleOptions
extends Object

Options for creating a schedule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScheduleOptions.Builder

Method Summary

Modifier and Type	Method	Description
List<ScheduleBackfill>	getBackfills()	Get the time periods to take actions on as if that time passed right now.
Map<String,Object>	getMemo()	Get the memo for the schedule.
Map<String,?>	getSearchAttributes()	Deprecated. use getTypedSearchAttributes() instead.
SearchAttributes	getTypedSearchAttributes()	Get the search attributes for the schedule.
boolean	isTriggerImmediately()	Get if the schedule will be triggered immediately upon creation.
static ScheduleOptions.Builder	newBuilder()
static ScheduleOptions.Builder	newBuilder(ScheduleOptions options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newBuilder

public static ScheduleOptions.Builder newBuilder()

newBuilder

public static ScheduleOptions.Builder newBuilder(ScheduleOptions options)

isTriggerImmediately

public boolean isTriggerImmediately()

Get if the schedule will be triggered immediately upon creation.

Returns:

True if the schedule will trigger on creation

getBackfills

public List<ScheduleBackfill> getBackfills()

Get the time periods to take actions on as if that time passed right now.

Returns:

backfill requests

getMemo

public Map<String,Object> getMemo()

Get the memo for the schedule. Values for the memo cannot be null.

Returns:

memos for the schedule

getSearchAttributes

public Map<String,?> getSearchAttributes()

Deprecated.

use getTypedSearchAttributes() instead.

Get the search attributes for the schedule.

Returns:

search attributes for the schedule

getTypedSearchAttributes

public SearchAttributes getTypedSearchAttributes()

Get the search attributes for the schedule.

Returns:

search attributes for the schedule