io.whitfin.elasticsearch.bulk

Interface BulkAction.Builder

Enclosing class:

BulkAction

public static interface BulkAction.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
BulkAction	build() Constructs a new BulkAction from this builder.
BulkAction.Builder	id(String id) Sets the document identifier, if any.
BulkAction.Builder	index(String index) Sets the name of the targeted index, if any.
BulkAction.Builder	operation(String operation) Sets the operation being carried out in the action.
BulkAction.Builder	parent(String parent) Sets the parent identifier, if any.
BulkAction.Builder	refresh(Boolean refresh) Sets whether the action should trigger a refresh.
BulkAction.Builder	routing(String routing) Sets the routing key of the action, if any.
BulkAction.Builder	source(String source) Sets the source body of the action.
BulkAction.Builder	type(String type) Sets the name of the targeted type, if any.
BulkAction.Builder	version(Integer version) Sets the version of the target document, if any.
BulkAction.Builder	waitForActiveShards(Boolean waitForActiveShards) Sets whether the action should wait for active shards.

Method Detail

operation

BulkAction.Builder operation(String operation)

Sets the operation being carried out in the action.

Parameters:

operation - the name of the Elasticsearch operation.

Returns:

the BulkAction.Builder instance for chaining calls.

index

BulkAction.Builder index(String index)

Sets the name of the targeted index, if any.

Parameters:

index - the name of the targeted index.

Returns:

the BulkAction.Builder instance for chaining calls.

type

BulkAction.Builder type(String type)

Sets the name of the targeted type, if any.

Parameters:

type - the name of the targeted type.

Returns:

the BulkAction.Builder instance for chaining calls.

id

BulkAction.Builder id(String id)

Sets the document identifier, if any.

Parameters:

id - the document identifier to operate on.

Returns:

the BulkAction.Builder instance for chaining calls.

parent

BulkAction.Builder parent(String parent)

Sets the parent identifier, if any.

Parameters:

parent - the parent document identifier.

Returns:

the BulkAction.Builder instance for chaining calls.

routing

BulkAction.Builder routing(String routing)

Sets the routing key of the action, if any.

Parameters:

routing - the routing key to apply to the operation.

Returns:

the BulkAction.Builder instance for chaining calls.

source

BulkAction.Builder source(String source)

Sets the source body of the action.

Parameters:

source - the source of the request as a String.

Returns:

the BulkAction.Builder instance for chaining calls.

version

BulkAction.Builder version(Integer version)

Sets the version of the target document, if any.

Parameters:

version - an integer version identifier.

Returns:

the BulkAction.Builder instance for chaining calls.

refresh

BulkAction.Builder refresh(Boolean refresh)

Sets whether the action should trigger a refresh.

Parameters:

refresh - a boolean representing a triggered refresh.

Returns:

the BulkAction.Builder instance for chaining calls.

waitForActiveShards

BulkAction.Builder waitForActiveShards(Boolean waitForActiveShards)

Sets whether the action should wait for active shards.

Parameters:

waitForActiveShards - a boolean representing whether to wait or not.

Returns:

the BulkAction.Builder instance for chaining calls.

build

BulkAction build()

Constructs a new BulkAction from this builder.

Returns:

a new BulkAction instance.