io.whitfin.elasticsearch.bulk

Class ImmutableBulkAction

java.lang.Object

io.whitfin.elasticsearch.bulk.BulkAction

io.whitfin.elasticsearch.bulk.ImmutableBulkAction

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","BulkAction"})
 @Immutable
public final class ImmutableBulkAction
extends BulkAction

Immutable implementation of BulkAction.

Use the builder to create immutable instances: new BulkAction.Builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableBulkAction.Builder Builds instances of type ImmutableBulkAction.

Method Summary

Modifier and Type	Method and Description
static ImmutableBulkAction	copyOf(BulkAction instance) Creates an immutable copy of a BulkAction value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableBulkAction that have equal attribute values.
int	hashCode() Computes a hash code from attributes: operation, index, type, id, parent, routing, source, version, refresh, waitForActiveShards.
String	id() The document identifier targeted by this action.
String	index() The index targeted by this action.
String	operation() The type of operation to carry out inside this action.
String	parent() The parent identifier associated with this action.
Boolean	refresh() Whether this action should cause a refresh or not.
String	routing() The routing identifier associated with this action.
String	source() The source body associated with this action.
String	toString() Prints the immutable value BulkAction with attribute values.
String	type() The index type targeted by this action.
Integer	version() The document version associated with this action.
Boolean	waitForActiveShards() Whether this action should wait for shards or not.
ImmutableBulkAction	withId(String value) Copy the current immutable object by setting a value for the id attribute.
ImmutableBulkAction	withIndex(String value) Copy the current immutable object by setting a value for the index attribute.
ImmutableBulkAction	withOperation(String value) Copy the current immutable object by setting a value for the operation attribute.
ImmutableBulkAction	withParent(String value) Copy the current immutable object by setting a value for the parent attribute.
ImmutableBulkAction	withRefresh(Boolean value) Copy the current immutable object by setting a value for the refresh attribute.
ImmutableBulkAction	withRouting(String value) Copy the current immutable object by setting a value for the routing attribute.
ImmutableBulkAction	withSource(String value) Copy the current immutable object by setting a value for the source attribute.
ImmutableBulkAction	withType(String value) Copy the current immutable object by setting a value for the type attribute.
ImmutableBulkAction	withVersion(Integer value) Copy the current immutable object by setting a value for the version attribute.
ImmutableBulkAction	withWaitForActiveShards(Boolean value) Copy the current immutable object by setting a value for the waitForActiveShards attribute.

Methods inherited from class io.whitfin.elasticsearch.bulk.BulkAction

builder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

operation

public String operation()

The type of operation to carry out inside this action.

Specified by:

operation in class BulkAction

Returns:

a String operation name.

index

@Nullable
public String index()

The index targeted by this action.

Specified by:

index in class BulkAction

Returns:

a String index name.

type

@Nullable
public String type()

The index type targeted by this action.

Specified by:

type in class BulkAction

Returns:

a String type name.

id

@Nullable
public String id()

The document identifier targeted by this action.

Specified by:

id in class BulkAction

Returns:

a String document identifier.

parent

@Nullable
public String parent()

The parent identifier associated with this action.

Specified by:

parent in class BulkAction

Returns:

a String parent identifier.

routing

@Nullable
public String routing()

The routing identifier associated with this action.

Specified by:

routing in class BulkAction

Returns:

a String routing identifier.

source

@Nullable
public String source()

The source body associated with this action.

Specified by:

source in class BulkAction

Returns:

a String source body.

version

@Nullable
public Integer version()

The document version associated with this action.

Specified by:

version in class BulkAction

Returns:

an Integer document version

refresh

@Nullable
public Boolean refresh()

Whether this action should cause a refresh or not.

Specified by:

refresh in class BulkAction

Returns:

true if a refresh should be triggered.

waitForActiveShards

@Nullable
public Boolean waitForActiveShards()

Whether this action should wait for shards or not.

Specified by:

waitForActiveShards in class BulkAction

Returns:

true if the action should wait for shards.

withOperation

public final ImmutableBulkAction withOperation(String value)

Copy the current immutable object by setting a value for the operation attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for operation

Returns:

A modified copy of the this object

withIndex

public final ImmutableBulkAction withIndex(@Nullable
                                           String value)

Copy the current immutable object by setting a value for the index attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for index (can be null)

Returns:

A modified copy of the this object

withType

public final ImmutableBulkAction withType(@Nullable
                                          String value)

Copy the current immutable object by setting a value for the type attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for type (can be null)

Returns:

A modified copy of the this object

withId

public final ImmutableBulkAction withId(@Nullable
                                        String value)

Copy the current immutable object by setting a value for the id attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for id (can be null)

Returns:

A modified copy of the this object

withParent

public final ImmutableBulkAction withParent(@Nullable
                                            String value)

Copy the current immutable object by setting a value for the parent attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for parent (can be null)

Returns:

A modified copy of the this object

withRouting

public final ImmutableBulkAction withRouting(@Nullable
                                             String value)

Copy the current immutable object by setting a value for the routing attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for routing (can be null)

Returns:

A modified copy of the this object

withSource

public final ImmutableBulkAction withSource(@Nullable
                                            String value)

Copy the current immutable object by setting a value for the source attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for source (can be null)

Returns:

A modified copy of the this object

withVersion

public final ImmutableBulkAction withVersion(@Nullable
                                             Integer value)

Copy the current immutable object by setting a value for the version attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for version (can be null)

Returns:

A modified copy of the this object

withRefresh

public final ImmutableBulkAction withRefresh(@Nullable
                                             Boolean value)

Copy the current immutable object by setting a value for the refresh attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for refresh (can be null)

Returns:

A modified copy of the this object

withWaitForActiveShards

public final ImmutableBulkAction withWaitForActiveShards(@Nullable
                                                         Boolean value)

Copy the current immutable object by setting a value for the waitForActiveShards attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for waitForActiveShards (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableBulkAction that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: operation, index, type, id, parent, routing, source, version, refresh, waitForActiveShards.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BulkAction with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableBulkAction copyOf(BulkAction instance)

Creates an immutable copy of a BulkAction value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable BulkAction instance