com.netflix.spectator.impl

Class Scheduler.Options

java.lang.Object

com.netflix.spectator.impl.Scheduler.Options

Enclosing class:

Scheduler

public static class Scheduler.Options
extends Object

Options to control how a task will get executed.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
Scheduler.Options	withFrequency(Scheduler.Policy policy, Duration frequency) Configure the task to execute repeatedly.
Scheduler.Options	withInitialDelay(Duration delay) How long to wait after a task has been scheduled to the first execution.
Scheduler.Options	withStopOnFailure(boolean flag) Should a repeated task stop executing if an exception propagates out of the task? Defaults to false.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

withInitialDelay

public Scheduler.Options withInitialDelay(Duration delay)

How long to wait after a task has been scheduled to the first execution. If not set, then it will be scheduled immediately.

withFrequency

public Scheduler.Options withFrequency(Scheduler.Policy policy,
                                       Duration frequency)

Configure the task to execute repeatedly.

Parameters:

policy - Repetition schedulingPolicy to use for the task. See Scheduler.Policy for the supported options.

frequency - How frequently to repeat the execution. The interpretation of this parameter will depend on the Scheduler.Policy.

withStopOnFailure

public Scheduler.Options withStopOnFailure(boolean flag)

Should a repeated task stop executing if an exception propagates out of the task? Defaults to false.