Package org.elasticsearch.action.bulk

Class BulkProcessor

java.lang.Object

org.elasticsearch.action.bulk.BulkProcessor

All Implemented Interfaces:

Closeable, AutoCloseable

public class BulkProcessor
extends Object
implements Closeable

A bulk processor is a thread safe bulk processing class, allowing to easily set when to "flush" a new bulk request (either based on number of actions, based on the size, or time), and to easily control the number of concurrent bulk requests allowed to be executed in parallel.

In order to create a new bulk processor, use the BulkProcessor.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkProcessor.Builder	A builder used to create a build an instance of a bulk processor.
static interface	BulkProcessor.Listener	A listener for the execution.

Method Summary

Modifier and Type	Method	Description
BulkProcessor	add(DeleteRequest request)	Adds an DeleteRequest to the list of actions to execute.
BulkProcessor	add(DocWriteRequest<?> request)	Adds either a delete or an index request.
BulkProcessor	add(IndexRequest request)	Adds an IndexRequest to the list of actions to execute.
BulkProcessor	add(BytesReference data, String defaultIndex, String defaultType, String defaultPipeline, org.elasticsearch.common.xcontent.XContentType xContentType)	Adds the data from the bytes to be processed by the bulk processor
BulkProcessor	add(BytesReference data, String defaultIndex, String defaultType, org.elasticsearch.common.xcontent.XContentType xContentType)	Adds the data from the bytes to be processed by the bulk processor
boolean	awaitClose(long timeout, TimeUnit unit)	Closes the processor.
static BulkProcessor.Builder	builder(BiConsumer<BulkRequest,ActionListener<BulkResponse>> consumer, BulkProcessor.Listener listener)	Deprecated. use builder(BiConsumer, Listener, String) instead
static BulkProcessor.Builder	builder(BiConsumer<BulkRequest,ActionListener<BulkResponse>> consumer, BulkProcessor.Listener listener, String name)
static BulkProcessor.Builder	builder(Client client, BulkProcessor.Listener listener)	Deprecated. Use builder(BiConsumer, Listener, String) with client::bulk as the first argument, or builder(org.elasticsearch.client.Client, org.elasticsearch.action.bulk.BulkProcessor.Listener, org.elasticsearch.threadpool.Scheduler, org.elasticsearch.threadpool.Scheduler, java.lang.Runnable) and manage the flush and retry schedulers explicitly
static BulkProcessor.Builder	builder(Client client, BulkProcessor.Listener listener, Scheduler flushScheduler, Scheduler retryScheduler, Runnable onClose)
void	close()	Closes the processor.
protected void	ensureOpen()
void	flush()	Flush pending delete or index requests.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static BulkProcessor.Builder builder(Client client,
 BulkProcessor.Listener listener,
 Scheduler flushScheduler,
 Scheduler retryScheduler,
 Runnable onClose)

Parameters:

client - The client that executes the bulk operations

listener - The BulkProcessor listener that gets called on bulk events

flushScheduler - The scheduler that is used to flush

retryScheduler - The scheduler that is used for retries

onClose - The runnable instance that is executed on close. Consumers are required to clean up the schedulers.

Returns:

the builder for BulkProcessor

builder

@Deprecated
public static BulkProcessor.Builder builder(Client client,
 BulkProcessor.Listener listener)

Deprecated.

Use builder(BiConsumer, Listener, String) with client::bulk as the first argument, or builder(org.elasticsearch.client.Client, org.elasticsearch.action.bulk.BulkProcessor.Listener, org.elasticsearch.threadpool.Scheduler, org.elasticsearch.threadpool.Scheduler, java.lang.Runnable) and manage the flush and retry schedulers explicitly

Parameters:

client - The client that executes the bulk operations

listener - The BulkProcessor listener that gets called on bulk events

Returns:

the builder for BulkProcessor

builder

@Deprecated
public static BulkProcessor.Builder builder(BiConsumer<BulkRequest,ActionListener<BulkResponse>> consumer,
 BulkProcessor.Listener listener)

Deprecated.

use builder(BiConsumer, Listener, String) instead

Parameters:

consumer - The consumer that is called to fulfil bulk operations

listener - The BulkProcessor listener that gets called on bulk events

Returns:

the builder for BulkProcessor

builder

public static BulkProcessor.Builder builder(BiConsumer<BulkRequest,ActionListener<BulkResponse>> consumer,
 BulkProcessor.Listener listener,
 String name)

Parameters:

consumer - The consumer that is called to fulfil bulk operations

listener - The BulkProcessor listener that gets called on bulk events

name - The name of this processor, e.g. to identify the scheduler threads

Returns:

the builder for BulkProcessor

close

public void close()

Closes the processor. If flushing by time is enabled, then it's shutdown. Any remaining bulk actions are flushed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

awaitClose

public boolean awaitClose(long timeout,
 TimeUnit unit)
                   throws InterruptedException

Closes the processor. If flushing by time is enabled, then it's shutdown. Any remaining bulk actions are flushed.

If concurrent requests are not enabled, returns true immediately. If concurrent requests are enabled, waits for up to the specified timeout for all bulk requests to complete then returns true If the specified waiting time elapses before all bulk requests complete, false is returned.

Parameters:

timeout - The maximum time to wait for the bulk requests to complete

unit - The time unit of the timeout argument

Returns:

true if all bulk requests completed and false if the waiting time elapsed before all the bulk requests completed

Throws:

InterruptedException - If the current thread is interrupted

add

public BulkProcessor add(IndexRequest request)

Adds an IndexRequest to the list of actions to execute. Follows the same behavior of IndexRequest (for example, if no id is provided, one will be generated, or usage of the create flag).

add

public BulkProcessor add(DeleteRequest request)

Adds an DeleteRequest to the list of actions to execute.

add

public BulkProcessor add(DocWriteRequest<?> request)

Adds either a delete or an index request.

ensureOpen

protected void ensureOpen()

add

public BulkProcessor add(BytesReference data,
 @Nullable
 String defaultIndex,
 @Nullable
 String defaultType,
 org.elasticsearch.common.xcontent.XContentType xContentType)
                  throws Exception

Adds the data from the bytes to be processed by the bulk processor

Throws:

Exception

add

public BulkProcessor add(BytesReference data,
 @Nullable
 String defaultIndex,
 @Nullable
 String defaultType,
 @Nullable
 String defaultPipeline,
 org.elasticsearch.common.xcontent.XContentType xContentType)
                  throws Exception

Adds the data from the bytes to be processed by the bulk processor

Throws:

Exception

flush

public void flush()

Flush pending delete or index requests.