de.otto.edison.jobs.definition

Interface JobDefinition

All Known Implementing Classes:

DefaultJobDefinition

public interface JobDefinition

Since:

25.08.15

Method Summary

Modifier and Type	Method and Description
default java.util.Optional<java.lang.String>	cron() Optional cron expression used to specify when a job should be triggered.
java.lang.String	description() A human-readable description of the job.
default java.util.Optional<java.time.Duration>	fixedDelay() Optional fixed delay after that a job is triggered again.
java.lang.String	jobName() A human-readable name of the job.
java.lang.String	jobType() The type of the job that is specified by this JobDefinition.
default java.util.Optional<java.time.Duration>	maxAge()
default int	retries() Number of retries when starting a job is failing for some reason.
default java.util.Optional<java.time.Duration>	retryDelay() The duration after that a retry should be scheduled.

Method Detail

jobType

java.lang.String jobType()

The type of the job that is specified by this JobDefinition. Only one JobDefinition per type is supported.

Returns:

job type

jobName

java.lang.String jobName()

A human-readable name of the job.

Returns:

job name

description

java.lang.String description()

A human-readable description of the job.

Returns:

job description

maxAge

default java.util.Optional<java.time.Duration> maxAge()

fixedDelay

default java.util.Optional<java.time.Duration> fixedDelay()

Optional fixed delay after that a job is triggered again.

Returns:

optional fixed delay

cron

default java.util.Optional<java.lang.String> cron()

Optional cron expression used to specify when a job should be triggered.

Returns:

optional cron expression

retries

default int retries()

Number of retries when starting a job is failing for some reason.

Returns:

number of retries

retryDelay

default java.util.Optional<java.time.Duration> retryDelay()

The duration after that a retry should be scheduled.

Returns:

optional delay before retrying