Package com.influxdb.client.reactive

Class WriteOptionsReactive

java.lang.Object

com.influxdb.client.reactive.WriteOptionsReactive

All Implemented Interfaces:

WriteApi.RetryOptions

@ThreadSafe
public final class WriteOptionsReactive
extends Object
implements WriteApi.RetryOptions

The configuration for WriteReactiveApi.

Example:

     WriteOptionsReactive writeOptions = WriteOptionsReactive.builder()
                 .batchSize(10_000)
                 .flushInterval(500)
                 .jitterInterval(1_000)
                 .retryInterval(2_000)
                 .maxRetries(5)
                 .maxRetryDelay(250_123)
                 .maxRetryTime(500_000)
                 .exponentialBase(2)
                 .computationScheduler(Schedulers.newThread())
                 .build();
 

Author:

Jakub Bednar (05/08/2021 9:13)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WriteOptionsReactive.Builder	A builder for WriteOptionsReactive.

Field Summary

Fields

Modifier and Type	Field	Description
static final WriteOptionsReactive	DEFAULTS	Default configuration with values that are consistent with Telegraf.

Method Summary

Modifier and Type	Method	Description
static WriteOptionsReactive.Builder	builder()	Creates a builder instance.
int	getBatchSize()
io.reactivex.rxjava3.core.Scheduler	getComputationScheduler()
int	getExponentialBase()	The base for the exponential retry delay.
int	getFlushInterval()
int	getJitterInterval()	Jitters the batch flush interval by a random amount.
int	getMaxRetries()	The number of max retries when write fails.
int	getMaxRetryDelay()	The maximum delay between each retry attempt in milliseconds.
int	getMaxRetryTime()	The maximum total retry timeout in milliseconds.
int	getRetryInterval()	The retry interval is used when the InfluxDB server does not specify "Retry-After" header.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULTS

public static final WriteOptionsReactive DEFAULTS

Default configuration with values that are consistent with Telegraf.

Method Details

getBatchSize

public int getBatchSize()

Returns:

the number of data point to collect in batch

See Also:

• WriteOptionsReactive.Builder.batchSize(int)

getFlushInterval

public int getFlushInterval()

Returns:

the time to wait at most (milliseconds)

See Also:

• (int)

getJitterInterval

public int getJitterInterval()

Description copied from interface: WriteApi.RetryOptions

Jitters the batch flush interval by a random amount. This is primarily to avoid large write spikes for users running a large number of client instances. ie, a jitter of 5s and flush duration 10s means flushes will happen every 10-15s.

Specified by:

getJitterInterval in interface WriteApi.RetryOptions

Returns:

batch flush jitter interval value (milliseconds)

See Also:

• WriteOptionsReactive.Builder.jitterInterval(int)

getRetryInterval

public int getRetryInterval()

The retry interval is used when the InfluxDB server does not specify "Retry-After" header.
Retry-After: A non-negative decimal integer indicating the seconds to delay after the response is received.

Specified by:

getRetryInterval in interface WriteApi.RetryOptions

Returns:

the time to wait before retry unsuccessful write (milliseconds)

See Also:

• WriteOptionsReactive.Builder.retryInterval(int)

getMaxRetries

public int getMaxRetries()

The number of max retries when write fails.

Specified by:

getMaxRetries in interface WriteApi.RetryOptions

Returns:

number of max retries

See Also:

• WriteOptionsReactive.Builder.maxRetries(int)

getMaxRetryDelay

public int getMaxRetryDelay()

The maximum delay between each retry attempt in milliseconds.

Specified by:

getMaxRetryDelay in interface WriteApi.RetryOptions

Returns:

maximum delay

See Also:

• WriteOptionsReactive.Builder.maxRetryDelay(int)

getMaxRetryTime

public int getMaxRetryTime()

The maximum total retry timeout in milliseconds.

Returns:

maximum delay

See Also:

• WriteOptionsReactive.Builder.maxRetryTime(int)

getExponentialBase

public int getExponentialBase()

The base for the exponential retry delay.

The next delay is computed as: retryInterval * exponentialBase^(attempts-1) + random(jitterInterval)

Specified by:

getExponentialBase in interface WriteApi.RetryOptions

Returns:

exponential base

See Also:

• WriteOptionsReactive.Builder.exponentialBase(int)

getComputationScheduler

@Nonnull
public io.reactivex.rxjava3.core.Scheduler getComputationScheduler()

Returns:

The scheduler which is used for computational work.

See Also:

• WriteOptionsReactive.Builder.computationScheduler(Scheduler)

builder

@Nonnull
public static WriteOptionsReactive.Builder builder()

Creates a builder instance.

Returns:

a builder