io.whitfin.elasticsearch.bulk

Class BulkAction

java.lang.Object

io.whitfin.elasticsearch.bulk.BulkAction

Direct Known Subclasses:

ImmutableBulkAction

@Value.Immutable
public abstract class BulkAction
extends Object

Interface for a bulk action as per the Elasticsearch API specification. A BulkAction is an action which can be queued into a BulkOperation to carry out batch actions against Elasticsearch. Each action has a contained definition as the bulk does not have any knowledge of the actions themselves (e.g. it doesn't infer indices, etc). Almost everything in here is optional, aside from the operation name itself. This is because only the index and type make sense otherwise, but they can be specified in the API call itself via the Elasticsearch path and so they must be nullable.

See Also:

Elasticsearch Bulk API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BulkAction.Builder Builder bindings to allow for creating actions with validation.

Constructor Summary

Constructors

Constructor and Description
BulkAction()

Method Summary

Modifier and Type	Method and Description
static BulkAction.Builder	builder() Returns a builder in order to create an action.
abstract String	id() The document identifier targeted by this action.
abstract String	index() The index targeted by this action.
abstract String	operation() The type of operation to carry out inside this action.
abstract String	parent() The parent identifier associated with this action.
abstract Boolean	refresh() Whether this action should cause a refresh or not.
abstract String	routing() The routing identifier associated with this action.
abstract String	source() The source body associated with this action.
abstract String	type() The index type targeted by this action.
abstract Integer	version() The document version associated with this action.
abstract Boolean	waitForActiveShards() Whether this action should wait for shards or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkAction

public BulkAction()

Method Detail

operation

public abstract String operation()

The type of operation to carry out inside this action.

Returns:

a String operation name.

index

@Nullable
public abstract String index()

The index targeted by this action.

Returns:

a String index name.

type

@Nullable
public abstract String type()

The index type targeted by this action.

Returns:

a String type name.

id

@Nullable
public abstract String id()

The document identifier targeted by this action.

Returns:

a String document identifier.

parent

@Nullable
public abstract String parent()

The parent identifier associated with this action.

Returns:

a String parent identifier.

routing

@Nullable
public abstract String routing()

The routing identifier associated with this action.

Returns:

a String routing identifier.

source

@Nullable
public abstract String source()

The source body associated with this action.

Returns:

a String source body.

version

@Nullable
public abstract Integer version()

The document version associated with this action.

Returns:

an Integer document version

refresh

@Nullable
public abstract Boolean refresh()

Whether this action should cause a refresh or not.

Returns:

true if a refresh should be triggered.

waitForActiveShards

@Nullable
public abstract Boolean waitForActiveShards()

Whether this action should wait for shards or not.

Returns:

true if the action should wait for shards.

builder

public static BulkAction.Builder builder()

Returns a builder in order to create an action.

Returns:

a new BulkAction.Builder instance.