WriteOptions (The Java InfluxDB 2.x Client 6.12.0 API)

java.lang.Object
- com.influxdb.client.WriteOptions

All Implemented Interfaces:

WriteApi.RetryOptions
```
@ThreadSafe
public final class WriteOptions
extends Object
implements WriteApi.RetryOptions
```
WriteOptions are used to configure writes the data point into InfluxDB 2.x.
The default setting use the batching configured to (consistent with Telegraf):
- batchSize = 1000
- flushInterval = 1000 ms
- retryInterval = 5000 ms
- jitterInterval = 0
- bufferLimit = 10_000
The default backpressure strategy is BackpressureOverflowStrategy.DROP_OLDEST.
Author:

Jakub Bednar (bednar@github) (21/09/2018 10:11)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WriteOptions.Builder
A builder for WriteOptions.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WriteOptions.Builder` A builder for `WriteOptions`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BATCH_SIZE`
`static int`	`DEFAULT_BUFFER_LIMIT`
`static int`	`DEFAULT_EXPONENTIAL_BASE`
`static int`	`DEFAULT_FLUSH_INTERVAL`
`static int`	`DEFAULT_JITTER_INTERVAL`
`static int`	`DEFAULT_MAX_RETRIES`
`static int`	`DEFAULT_MAX_RETRY_DELAY`
`static int`	`DEFAULT_MAX_RETRY_TIME`
`static int`	`DEFAULT_RETRY_INTERVAL`
`static WriteOptions`	`DEFAULTS` Default configuration with values that are consistent with Telegraf.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WriteOptions.Builder`	`builder()` Creates a builder instance.
`io.reactivex.rxjava3.core.BackpressureOverflowStrategy`	`getBackpressureStrategy()`
`int`	`getBatchSize()`
`int`	`getBufferLimit()`
`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.
`io.reactivex.rxjava3.core.Scheduler`	`getWriteScheduler()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BATCH_SIZE
```
public static final int DEFAULT_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FLUSH_INTERVAL
```
public static final int DEFAULT_FLUSH_INTERVAL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_JITTER_INTERVAL
```
public static final int DEFAULT_JITTER_INTERVAL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RETRY_INTERVAL
```
public static final int DEFAULT_RETRY_INTERVAL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RETRIES
```
public static final int DEFAULT_MAX_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RETRY_DELAY
```
public static final int DEFAULT_MAX_RETRY_DELAY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RETRY_TIME
```
public static final int DEFAULT_MAX_RETRY_TIME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_EXPONENTIAL_BASE
```
public static final int DEFAULT_EXPONENTIAL_BASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BUFFER_LIMIT
```
public static final int DEFAULT_BUFFER_LIMIT
```
    See Also:
    
    Constant Field Values
  - DEFAULTS
```
public static final WriteOptions DEFAULTS
```
    Default configuration with values that are consistent with Telegraf.
- Method Detail
  - getBatchSize
```
public int getBatchSize()
```
    Returns:
    
    the number of data point to collect in batch
    
    See Also:
    
    WriteOptions.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:
    
    WriteOptions.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:
    
    WriteOptions.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:
    
    WriteOptions.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:
    
    WriteOptions.Builder.maxRetryDelay(int)
  - getMaxRetryTime
```
public int getMaxRetryTime()
```
    The maximum total retry timeout in milliseconds.
    
    Returns:
    
    maximum delay
    
    See Also:
    
    WriteOptions.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:
    
    WriteOptions.Builder.exponentialBase(int)
  - getBufferLimit
```
public int getBufferLimit()
```
    Returns:
    
    Maximum number of points stored in the retry buffer.
    
    See Also:
    
    WriteOptions.Builder.bufferLimit(int)
  - getWriteScheduler
```
@Nonnull
public io.reactivex.rxjava3.core.Scheduler getWriteScheduler()
```
    Returns:
    
    The scheduler which is used for write data points.
    
    See Also:
    
    WriteOptions.Builder.writeScheduler(Scheduler)
  - getBackpressureStrategy
```
@Nonnull
public io.reactivex.rxjava3.core.BackpressureOverflowStrategy getBackpressureStrategy()
```
    Returns:
    
    the strategy to deal with buffer overflow when using onBackpressureBuffer
    
    See Also:
    
    WriteOptions.Builder.backpressureStrategy(BackpressureOverflowStrategy)
  - builder
```
@Nonnull
public static WriteOptions.Builder builder()
```
    Creates a builder instance.
    
    Returns:
    
    a builder

Class WriteOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BATCH_SIZE

DEFAULT_FLUSH_INTERVAL

DEFAULT_JITTER_INTERVAL

DEFAULT_RETRY_INTERVAL

DEFAULT_MAX_RETRIES

DEFAULT_MAX_RETRY_DELAY

DEFAULT_MAX_RETRY_TIME

DEFAULT_EXPONENTIAL_BASE

DEFAULT_BUFFER_LIMIT

DEFAULTS

Method Detail

getBatchSize

getFlushInterval

getJitterInterval

getRetryInterval

getMaxRetries

getMaxRetryDelay

getMaxRetryTime

getExponentialBase

getBufferLimit

getWriteScheduler

getBackpressureStrategy

builder