io.whitfin.elasticsearch.bulk

Class ImmutableBulkOperation

java.lang.Object

io.whitfin.elasticsearch.bulk.BulkOperation

io.whitfin.elasticsearch.bulk.ImmutableBulkOperation

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

Immutable implementation of BulkOperation.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
List<BulkAction>	actions() The list of actions associated with this operation.
static ImmutableBulkOperation	copyOf(BulkOperation instance) Creates an immutable copy of a BulkOperation value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableBulkOperation that have equal attribute values.
long	estimatedSizeInBytes() The estimated size of this operation.
int	hashCode() Computes a hash code from attributes: actions, estimatedSizeInBytes, numberOfActions, payload.
long	numberOfActions() The number of actions in this operation.
String	payload() The textual representation of this operation.
String	toString() Prints the immutable value BulkOperation with attribute values.
ImmutableBulkOperation	withActions(BulkAction... elements) Copy the current immutable object with elements that replace the content of actions.
ImmutableBulkOperation	withActions(Iterable<? extends BulkAction> elements) Copy the current immutable object with elements that replace the content of actions.

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

builder

Methods inherited from class java.lang.Object

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

Method Detail

actions

public List<BulkAction> actions()

The list of actions associated with this operation.

Specified by:

actions in class BulkOperation

Returns:

a List of actions to execute.

estimatedSizeInBytes

public long estimatedSizeInBytes()

The estimated size of this operation.

Overrides:

estimatedSizeInBytes in class BulkOperation

Returns:

the length of the internal payload.

numberOfActions

public long numberOfActions()

The number of actions in this operation.

Overrides:

numberOfActions in class BulkOperation

Returns:

the size of the internal action list.

payload

public String payload()

The textual representation of this operation.

Overrides:

payload in class BulkOperation

Returns:

a String payload to pass to the API.

withActions

public final ImmutableBulkOperation withActions(BulkAction... elements)

Copy the current immutable object with elements that replace the content of actions.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withActions

public final ImmutableBulkOperation withActions(Iterable<? extends BulkAction> elements)

Copy the current immutable object with elements that replace the content of actions. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of actions elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableBulkOperation 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: actions, estimatedSizeInBytes, numberOfActions, payload.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BulkOperation with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableBulkOperation copyOf(BulkOperation instance)

Creates an immutable copy of a BulkOperation 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 BulkOperation instance