ai.grakn.engine.tasks.manager

Class TaskSchedule

java.lang.Object

ai.grakn.engine.tasks.manager.TaskSchedule

All Implemented Interfaces:

Serializable

public class TaskSchedule
extends Object
implements Serializable

Scheduling information for tasks, contained within a TaskState.

Author:

Felix Chapman

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskSchedule(java.time.Instant runAt, java.time.Duration interval)
TaskSchedule(long runAt, Long interval)

Method Summary

Modifier and Type	Method and Description
static TaskSchedule	at(java.time.Instant instant) Create a schedule to run a task at a specified instant.
Long	getInterval()
long	getRunAt()
TaskSchedule	incrementByInterval() Returns a copy of this Schedule that will start a task after the given interval
Optional<java.time.Duration>	interval() Get the interval that the task should recur, if it is a recurring task.
boolean	isRecurring() Get whether the task is a recurring task.
static TaskSchedule	now() Create a schedule to run a task now.
static TaskSchedule	recurring(java.time.Duration interval) Create a schedule to run a task that recurs on an interval.
static TaskSchedule	recurring(java.time.Instant instant, java.time.Duration interval) Create a schedule to run a task that recurs on an interval, starting at the specified instance.
java.time.Instant	runAt() Get the instant the task is specified to run at.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskSchedule

public TaskSchedule(java.time.Instant runAt,
                    @Nullable
                    java.time.Duration interval)

TaskSchedule

public TaskSchedule(long runAt,
                    @Nullable
                    Long interval)

Method Detail

now

public static TaskSchedule now()

Create a schedule to run a task now.

at

public static TaskSchedule at(java.time.Instant instant)

Create a schedule to run a task at a specified instant.

recurring

public static TaskSchedule recurring(java.time.Duration interval)

Create a schedule to run a task that recurs on an interval.

recurring

public static TaskSchedule recurring(java.time.Instant instant,
                                     java.time.Duration interval)

Create a schedule to run a task that recurs on an interval, starting at the specified instance.

runAt

public java.time.Instant runAt()

Get the instant the task is specified to run at.

getRunAt

public long getRunAt()

interval

public Optional<java.time.Duration> interval()

Get the interval that the task should recur, if it is a recurring task.

getInterval

public Long getInterval()

isRecurring

public boolean isRecurring()

Get whether the task is a recurring task.

incrementByInterval

public TaskSchedule incrementByInterval()

Returns a copy of this Schedule that will start a task after the given interval

Returns:

a Schedule with the given amount added