io.whitfin.elasticsearch.bulk

Class BulkOperation

java.lang.Object

io.whitfin.elasticsearch.bulk.BulkOperation

@Value.Immutable(copy=false)
public abstract class BulkOperation
extends Object

Definition class of a bulk operation per the Elasticsearch Bulk API. This class allows aggregation of BulkAction instances into a single batch to be executed against Elasticsearch at a single point in time, via a single HTTP request. The only modifiable state of this class is the actions list, which can be modified via the BulkAction.Builder. All other values are derived at build time as they'll never change, and we can assume that they'll always be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BulkOperation.Builder Builder interface for all immutable implementations to mask the use of the generated sources to avoid confusion.

Constructor Summary

Constructors

Constructor and Description
BulkOperation()

Method Summary

Modifier and Type	Method and Description
abstract List<BulkAction>	actions() The list of actions associated with this operation.
static BulkOperation.Builder	builder() Returns a builder in order to create an operation.
long	estimatedSizeInBytes() The estimated size of this operation.
long	numberOfActions() The number of actions in this operation.
String	payload() The textual representation of this operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkOperation

public BulkOperation()

Method Detail

actions

public abstract List<BulkAction> actions()

The list of actions associated with this operation.

Returns:

a List of actions to execute.

estimatedSizeInBytes

@Value.Derived
public long estimatedSizeInBytes()

The estimated size of this operation.

Returns:

the length of the internal payload.

numberOfActions

@Value.Derived
public long numberOfActions()

The number of actions in this operation.

Returns:

the size of the internal action list.

payload

@Value.Derived
public String payload()

The textual representation of this operation.

Returns:

a String payload to pass to the API.

builder

public static BulkOperation.Builder builder()

Returns a builder in order to create an operation.

Returns:

a new BulkAction.Builder instance.