Package co.elastic.clients.elasticsearch.core.bulk

Class BulkOperation

java.lang.Object

co.elastic.clients.elasticsearch.core.bulk.BulkOperation

All Implemented Interfaces:

JsonpSerializable, NdJsonpSerializable, TaggedUnion<BulkOperation.Kind,Object>

public class BulkOperation
extends Object
implements TaggedUnion<BulkOperation.Kind,Object>, NdJsonpSerializable, JsonpSerializable

An action line, which is the first line of each operation in a bulk request. It specifies the action to perform (index, create, update, or delete) and its metadata, such as the target index and document ID. All actions except delete expect a source line to follow.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkOperation.Builder
static enum	BulkOperation.Kind	BulkOperation variant kinds.

Constructor Summary

Constructors

Constructor	Description
BulkOperation(BulkOperationVariant value)

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final BulkOperation.Kind	_kind()	Get the of the kind of variant held by this object.
Iterator<?>	_serializables()
<TDocument> CreateOperation<TDocument>	create()	Get the create variant value.
DeleteOperation	delete()	Get the delete variant value.
<TDocument> IndexOperation<TDocument>	index()	Get the index variant value.
boolean	isCreate()	Is this variant instance of kind create?
boolean	isDelete()	Is this variant instance of kind delete?
boolean	isIndex()	Is this variant instance of kind index?
boolean	isUpdate()	Is this variant instance of kind update?
static BulkOperation	of(Function<BulkOperation.Builder,ObjectBuilder<BulkOperation>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
String	toString()
<TDocument, TPartialDocument> UpdateOperation<TDocument,TPartialDocument>	update()	Get the update variant value.

Methods inherited from class java.lang.Object

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

Constructor Details

BulkOperation

public BulkOperation(BulkOperationVariant value)

Method Details

_kind

public final BulkOperation.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<BulkOperation.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<BulkOperation.Kind,Object>

of

public static BulkOperation of(Function<BulkOperation.Builder,ObjectBuilder<BulkOperation>> fn)

_serializables

public Iterator<?> _serializables()

Specified by:

_serializables in interface NdJsonpSerializable

isIndex

public boolean isIndex()

Is this variant instance of kind index?

index

public <TDocument> IndexOperation<TDocument> index()

Get the index variant value.

Throws:

IllegalStateException - if the current variant is not of the index kind.

isCreate

public boolean isCreate()

Is this variant instance of kind create?

create

public <TDocument> CreateOperation<TDocument> create()

Get the create variant value.

Throws:

IllegalStateException - if the current variant is not of the create kind.

isUpdate

public boolean isUpdate()

Is this variant instance of kind update?

update

public <TDocument,
TPartialDocument>
UpdateOperation<TDocument,TPartialDocument> update()

Get the update variant value.

Throws:

IllegalStateException - if the current variant is not of the update kind.

isDelete

public boolean isDelete()

Is this variant instance of kind delete?

delete

public DeleteOperation delete()

Get the delete variant value.

Throws:

IllegalStateException - if the current variant is not of the delete kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object