Jabbit/tech.ryadom.jabbit/PeriodicJobRequest/Builder

Builder

class Builder : JobRequest.Builder<PeriodicJobRequest.Builder> (source)

Builder for PeriodicJobRequest.

Functions

fun addTag(tag: String): PeriodicJobRequest.Builder

Adds a tag used to observe or cancel this job together with others.

fun addTags(tags: Iterable<String>): PeriodicJobRequest.Builder

Adds several tags at once.

fun build(): PeriodicJobRequest

Builds the request.

setBackoffCriteria

fun setBackoffCriteria(policy: BackoffPolicy, delay: Duration): PeriodicJobRequest.Builder

Sets how retries are spaced apart.

setBackoffCriteriaMillis

fun setBackoffCriteriaMillis(policy: BackoffPolicy, millis: Long): PeriodicJobRequest.Builder

Sets how retries are spaced apart, with the first retry delayed by millis.

fun setConstraints(constraints: Constraints): PeriodicJobRequest.Builder

Sets the device conditions required before the job may run.

setFlexInterval

fun setFlexInterval(duration: Duration): PeriodicJobRequest.Builder

Restricts the job to the last duration of every period.

setFlexIntervalMillis

fun setFlexIntervalMillis(millis: Long): PeriodicJobRequest.Builder

Restricts the job to the last millis milliseconds of every period.

fun setId(id: JobId): PeriodicJobRequest.Builder

Uses an explicit identifier instead of a generated one.

setInitialDelay

fun setInitialDelay(duration: Duration): PeriodicJobRequest.Builder

Delays the first run by duration.

setInitialDelayMillis

fun setInitialDelayMillis(millis: Long): PeriodicJobRequest.Builder

Delays the first run by millis.

fun setMaxAttempts(count: Int): PeriodicJobRequest.Builder

Gives up on the job once it has been started count times.