io.whitfin.elasticsearch.bulk

Class ImmutableBulkAction.Builder

java.lang.Object

io.whitfin.elasticsearch.bulk.ImmutableBulkAction.Builder

Direct Known Subclasses:

BulkAction.Builder

Enclosing class:

ImmutableBulkAction

@NotThreadSafe
public static class ImmutableBulkAction.Builder
extends Object

Builds instances of type ImmutableBulkAction. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a builder for ImmutableBulkAction instances.

Method Summary

Modifier and Type	Method and Description
ImmutableBulkAction	build() Builds a new ImmutableBulkAction.
BulkAction.Builder	from(BulkAction instance) Fill a builder with attribute values from the provided BulkAction instance.
BulkAction.Builder	id(String id) Initializes the value for the id attribute.
BulkAction.Builder	index(String index) Initializes the value for the index attribute.
BulkAction.Builder	operation(String operation) Initializes the value for the operation attribute.
BulkAction.Builder	parent(String parent) Initializes the value for the parent attribute.
BulkAction.Builder	refresh(Boolean refresh) Initializes the value for the refresh attribute.
BulkAction.Builder	routing(String routing) Initializes the value for the routing attribute.
BulkAction.Builder	source(String source) Initializes the value for the source attribute.
BulkAction.Builder	type(String type) Initializes the value for the type attribute.
BulkAction.Builder	version(Integer version) Initializes the value for the version attribute.
BulkAction.Builder	waitForActiveShards(Boolean waitForActiveShards) Initializes the value for the waitForActiveShards attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a builder for ImmutableBulkAction instances.

Method Detail

from

public final BulkAction.Builder from(BulkAction instance)

Fill a builder with attribute values from the provided BulkAction instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

operation

public final BulkAction.Builder operation(String operation)

Initializes the value for the operation attribute.

Parameters:

operation - The value for operation

Returns:

this builder for use in a chained invocation

index

public final BulkAction.Builder index(@Nullable
                                      String index)

Initializes the value for the index attribute.

Parameters:

index - The value for index (can be null)

Returns:

this builder for use in a chained invocation

type

public final BulkAction.Builder type(@Nullable
                                     String type)

Initializes the value for the type attribute.

Parameters:

type - The value for type (can be null)

Returns:

this builder for use in a chained invocation

id

public final BulkAction.Builder id(@Nullable
                                   String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id (can be null)

Returns:

this builder for use in a chained invocation

parent

public final BulkAction.Builder parent(@Nullable
                                       String parent)

Initializes the value for the parent attribute.

Parameters:

parent - The value for parent (can be null)

Returns:

this builder for use in a chained invocation

routing

public final BulkAction.Builder routing(@Nullable
                                        String routing)

Initializes the value for the routing attribute.

Parameters:

routing - The value for routing (can be null)

Returns:

this builder for use in a chained invocation

source

public final BulkAction.Builder source(@Nullable
                                       String source)

Initializes the value for the source attribute.

Parameters:

source - The value for source (can be null)

Returns:

this builder for use in a chained invocation

version

public final BulkAction.Builder version(@Nullable
                                        Integer version)

Initializes the value for the version attribute.

Parameters:

version - The value for version (can be null)

Returns:

this builder for use in a chained invocation

refresh

public final BulkAction.Builder refresh(@Nullable
                                        Boolean refresh)

Initializes the value for the refresh attribute.

Parameters:

refresh - The value for refresh (can be null)

Returns:

this builder for use in a chained invocation

waitForActiveShards

public final BulkAction.Builder waitForActiveShards(@Nullable
                                                    Boolean waitForActiveShards)

Initializes the value for the waitForActiveShards attribute.

Parameters:

waitForActiveShards - The value for waitForActiveShards (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableBulkAction build()

Builds a new ImmutableBulkAction.

Returns:

An immutable instance of BulkAction

Throws:

IllegalStateException - if any required attributes are missing