Package co.elastic.clients.elasticsearch._helpers.bulk

Class BulkIngester.Builder<Context>

java.lang.Object

co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester.Builder<Context>

All Implemented Interfaces:

ObjectBuilder<BulkIngester<Context>>

Enclosing class:

BulkIngester<Context>

public static class BulkIngester.Builder<Context>
extends Object
implements ObjectBuilder<BulkIngester<Context>>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BulkIngester.Builder<Context>	backoffPolicy(BackoffPolicy backoffPolicy)	Sets the backoff policy that will handle retries for error 429: too many requests.
BulkIngester<Context>	build()
BulkIngester.Builder<Context>	client(ElasticsearchAsyncClient client)
BulkIngester.Builder<Context>	client(ElasticsearchClient client)
BulkIngester.Builder<Context>	flushInterval(long value, TimeUnit unit)	Sets an interval flushing any bulk actions pending if the interval passes.
BulkIngester.Builder<Context>	flushInterval(long value, TimeUnit unit, ScheduledExecutorService scheduler)	Deprecated. use scheduler(ScheduledExecutorService)
BulkIngester.Builder<Context>	globalSettings(BulkRequest.Builder settings)	Sets global bulk request settings that will be applied to all requests sent by the ingester.
BulkIngester.Builder<Context>	globalSettings(Function<BulkRequest.Builder,BulkRequest.Builder> fn)	Sets global bulk request settings that will be applied to all bulk requests.
BulkIngester.Builder<Context>	listener(BulkListener<Context> listener)
BulkIngester.Builder<Context>	maxConcurrentRequests(int max)	Sets the number of concurrent requests allowed to be executed.
BulkIngester.Builder<Context>	maxOperations(int count)	Sets when to flush a new bulk request based on the number of operations currently added.
BulkIngester.Builder<Context>	maxSize(long bytes)	Sets when to flush a new bulk request based on the size in bytes of actions currently added.
BulkIngester.Builder<Context>	scheduler(ScheduledExecutorService scheduler)	Sets a custom scheduler to run the flush thread and the listener logic.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

client

public BulkIngester.Builder<Context> client(ElasticsearchAsyncClient client)

client

public BulkIngester.Builder<Context> client(ElasticsearchClient client)

maxOperations

public BulkIngester.Builder<Context> maxOperations(int count)

Sets when to flush a new bulk request based on the number of operations currently added. Defaults to 1000. Can be set to -1 to disable it.

Throws:

IllegalArgumentException - if less than -1.

maxSize

public BulkIngester.Builder<Context> maxSize(long bytes)

Sets when to flush a new bulk request based on the size in bytes of actions currently added. A request is sent once that size has been exceeded. Defaults to 5 megabytes. Can be set to -1 to disable it.

Throws:

IllegalArgumentException - if less than -1.

maxConcurrentRequests

public BulkIngester.Builder<Context> maxConcurrentRequests(int max)

Sets the number of concurrent requests allowed to be executed. A value of 1 means 1 request is allowed to be executed while accumulating new bulk requests. Defaults to 1.

Throws:

IllegalArgumentException - if less than 1.

flushInterval

public BulkIngester.Builder<Context> flushInterval(long value,
 TimeUnit unit)

Sets an interval flushing any bulk actions pending if the interval passes. Defaults to not set.

Flushing is still subject to the maximum number of requests set with maxConcurrentRequests.

Throws:

IllegalArgumentException - if not a positive duration.

flushInterval

@Deprecated
public BulkIngester.Builder<Context> flushInterval(long value,
 TimeUnit unit,
 ScheduledExecutorService scheduler)

Deprecated.

use scheduler(ScheduledExecutorService)

Sets an interval flushing any bulk actions pending if the interval passes. Defaults to not set.

Flushing is still subject to the maximum number of requests set with maxConcurrentRequests.

scheduler

public BulkIngester.Builder<Context> scheduler(ScheduledExecutorService scheduler)

Sets a custom scheduler to run the flush thread and the listener logic. A default one is used if not set.

listener

public BulkIngester.Builder<Context> listener(BulkListener<Context> listener)

backoffPolicy

public BulkIngester.Builder<Context> backoffPolicy(BackoffPolicy backoffPolicy)

Sets the backoff policy that will handle retries for error 429: too many requests. All the times are defined in milliseconds.

globalSettings

public BulkIngester.Builder<Context> globalSettings(BulkRequest.Builder settings)

Sets global bulk request settings that will be applied to all requests sent by the ingester.

globalSettings

public BulkIngester.Builder<Context> globalSettings(Function<BulkRequest.Builder,BulkRequest.Builder> fn)

Sets global bulk request settings that will be applied to all bulk requests.

build

public BulkIngester<Context> build()

Specified by:

build in interface ObjectBuilder<Context>