Class BackoffPolicy.Builder

java.lang.Object

org.apache.pulsar.client.api.v5.config.BackoffPolicy.Builder

Enclosing class:

BackoffPolicy

public static final class BackoffPolicy.Builder
extends Object

Builder for BackoffPolicy.

Method Summary

Modifier and Type	Method	Description
BackoffPolicy	build()
BackoffPolicy.Builder	initialInterval(Duration initialInterval)	Delay before the first reconnection attempt.
BackoffPolicy.Builder	jitterPercent(double jitterPercent)	Symmetric jitter percentage applied to each returned delay.
BackoffPolicy.Builder	maxInterval(Duration maxInterval)	Upper bound on the backoff delay.
BackoffPolicy.Builder	multiplier(double multiplier)	Multiplier applied to the previous delay on each retry.

Methods inherited from class Object

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

Method Details

initialInterval

public BackoffPolicy.Builder initialInterval(Duration initialInterval)

Delay before the first reconnection attempt. Required.

Parameters:

initialInterval - the initial backoff delay

Returns:

this builder

maxInterval

public BackoffPolicy.Builder maxInterval(Duration maxInterval)

Upper bound on the backoff delay. Required.

Parameters:

maxInterval - the maximum backoff delay

Returns:

this builder

multiplier

public BackoffPolicy.Builder multiplier(double multiplier)

Multiplier applied to the previous delay on each retry. Must be >= 1.0. Default is 2.0 (exponential backoff). Use 1.0 for fixed backoff.

Parameters:

multiplier - the per-attempt multiplier

Returns:

this builder

jitterPercent

public BackoffPolicy.Builder jitterPercent(double jitterPercent)

Symmetric jitter percentage applied to each returned delay. The actual jitter is the base delay multiplied by a uniform random factor in [1 - jitterPercent/200, 1 + jitterPercent/200). Default is 10.0; set to 0 to disable jitter.

Parameters:

jitterPercent - the jitter percentage, must be in [0, 100]

Returns:

this builder

build

public BackoffPolicy build()

Returns:

a new BackoffPolicy instance