io.whitfin.elasticsearch.bulk

Interface BulkOperator.Builder

Enclosing class:

BulkOperator

public static interface BulkOperator.Builder

Builder interface for all immutable implementations to mask the use of the generated sources to avoid confusion. These methods are the only ones exposed from the builder to the outside world (rather than just the package).

Method Summary

Modifier and Type	Method and Description
BulkOperator	build() Constructs a new BulkOperator from this builder.
BulkOperator.Builder	client(org.elasticsearch.client.RestClient client) Initializes a builder instance with an Elasticsearch client.
BulkOperator.Builder	concurrency(int concurrency) Modifies the concurrency associated with this builder.
BulkOperator.Builder	interval(Integer interval) Modifies the interval associated with this builder.
BulkOperator.Builder	lifecycle(BulkLifecycle lifecycle) Modifies the lifecycle associated with this builder.
BulkOperator.Builder	maxActions(Integer maxActions) Modifies the max number of actions associated with this builder.

Method Detail

client

BulkOperator.Builder client(org.elasticsearch.client.RestClient client)

Initializes a builder instance with an Elasticsearch client.

This client must not be null, as it's required for execution.

Parameters:

client - the RestClient to execute with.

Returns:

the BulkOperator.Builder instance for chaining calls.

concurrency

BulkOperator.Builder concurrency(int concurrency)

Modifies the concurrency associated with this builder.

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

Parameters:

concurrency - the new concurrency value.

Returns:

the BulkOperator.Builder instance for chaining calls.

interval

BulkOperator.Builder interval(Integer interval)

Modifies the interval associated with this builder.

Parameters:

interval - the new scheduled interval.

Returns:

the BulkOperator.Builder instance for chaining calls.

lifecycle

BulkOperator.Builder lifecycle(BulkLifecycle lifecycle)

Modifies the lifecycle associated with this builder.

If you wish to unset a previously set lifecycle, you should use NoopLifecycle rather than passing null.

Parameters:

lifecycle - the new lifecycle instance.

Returns:

the BulkOperator.Builder instance for chaining calls.

maxActions

BulkOperator.Builder maxActions(Integer maxActions)

Modifies the max number of actions associated with this builder.

Parameters:

maxActions - the new maximum number of actions.

Returns:

the BulkOperator.Builder instance for chaining calls.

build

BulkOperator build()

Constructs a new BulkOperator from this builder.

Returns:

a new BulkOperator instance.