io.whitfin.elasticsearch.bulk

Class BulkOperator

java.lang.Object

io.whitfin.elasticsearch.bulk.BulkOperator

All Implemented Interfaces:

Closeable, AutoCloseable

@Value.Immutable(copy=false)
public abstract class BulkOperator
extends Object
implements Closeable

The BulkOperator controls batch execution against Elasticsearch via the Elasticsearch Bulk API. It contains control over concurrency, throttling and lifecycle monitoring. To create an operator, you must go via the BulkOperator.Builder in order to get sane defaults and validation.

See Also:

Elasticsearch Bulk API

Constructor Summary

Constructors

Constructor and Description
BulkOperator()

Method Summary

Modifier and Type	Method and Description
BulkOperator	add(BulkAction... bulkActions) Adds new BulkAction instances to the internal bulk operation builder.
static io.whitfin.elasticsearch.bulk.BulkOperator.Builder	builder(org.elasticsearch.client.RestClient client) Returns a builder in order to create an operator.
abstract org.elasticsearch.client.RestClient	client() The client instance for Elasticsearch communication.
void	close() Closes all internal resources and sets the operator as closed.
int	concurrency() The concurrency level for this operator instance.
void	flush() Flushes all actions contained in the current buffer.
abstract Integer	interval() The interval on which this operator will flush.
BulkLifecycle	lifecycle() The lifecycle hooks being fired by this operator.
abstract Integer	maxActions() The maximum number of actions to buffer before flushing.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkOperator

public BulkOperator()

Method Detail

client

public abstract org.elasticsearch.client.RestClient client()

The client instance for Elasticsearch communication.

Returns:

a configured RestClient instance.

concurrency

@Value.Default
public int concurrency()

The concurrency level for this operator instance.

The concurrency can not be set below 1, the builder will enforce this lower bound.

Returns:

a number of concurrent flushes.

lifecycle

@Value.Default
public BulkLifecycle lifecycle()

The lifecycle hooks being fired by this operator.

Rather than making use of null values, a NoopLifecycle will be used to represent an unset lifecycle.

Returns:

a BulkLifecycle instance.

interval

@Nullable
public abstract Integer interval()

The interval on which this operator will flush.

Setting this to null will disable scheduling flushing.

Returns:

a flush interval in milliseconds.

maxActions

@Nullable
public abstract Integer maxActions()

The maximum number of actions to buffer before flushing.

Returns:

an maximum number of actions to buffer.

add

public BulkOperator add(BulkAction... bulkActions)

Adds new BulkAction instances to the internal bulk operation builder.

Parameters:

bulkActions - the BulkAction instances to add.

Returns:

the BulkOperator instance for chaining.

flush

public void flush()

Flushes all actions contained in the current buffer.

This uses a synchronized lock to ensure that the internal operation is reset without causing any potential race conditions.

The internal semaphore is used to control concurrency, by waiting for an acquired lock before executing the request internally.

close

public void close()

Closes all internal resources and sets the operator as closed.

We don't close the provided RestClient instance as it was provided and may be used in other classes.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

builder

public static io.whitfin.elasticsearch.bulk.BulkOperator.Builder builder(@Nonnull
                                                                         org.elasticsearch.client.RestClient client)

Returns a builder in order to create an operator.

Parameters:

client - the RestClient to use to talk to Elasticsearch.

Returns:

a new Builder instance from the provided client.