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

Class BulkResponseItem.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BulkResponseItem.Builder>

co.elastic.clients.elasticsearch.core.bulk.BulkResponseItem.Builder

All Implemented Interfaces:

WithJson<BulkResponseItem.Builder>, ObjectBuilder<BulkResponseItem>

Enclosing class:

BulkResponseItem

public static class BulkResponseItem.Builder
extends WithJsonObjectBuilderBase<BulkResponseItem.Builder>
implements ObjectBuilder<BulkResponseItem>

Builder for BulkResponseItem.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BulkResponseItem	build()	Builds a BulkResponseItem.
final BulkResponseItem.Builder	error(ErrorCause value)	Additional information about the failed operation.
final BulkResponseItem.Builder	error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)	Additional information about the failed operation.
final BulkResponseItem.Builder	failureStore(FailureStoreStatus value)	API name: failure_store
final BulkResponseItem.Builder	forcedRefresh(Boolean value)	API name: forced_refresh
final BulkResponseItem.Builder	get(InlineGet<Map<String,JsonData>> value)	API name: get
final BulkResponseItem.Builder	get(Function<InlineGet.Builder<Map<String,JsonData>>,ObjectBuilder<InlineGet<Map<String,JsonData>>>> fn)	API name: get
final BulkResponseItem.Builder	id(String value)	The document ID associated with the operation.
final BulkResponseItem.Builder	index(String value)	Required - The name of the index associated with the operation.
final BulkResponseItem.Builder	operationType(OperationType value)	Required -
final BulkResponseItem.Builder	primaryTerm(Long value)	The primary term assigned to the document for the operation.
final BulkResponseItem.Builder	result(String value)	The result of the operation.
protected BulkResponseItem.Builder	self()
final BulkResponseItem.Builder	seqNo(Long value)	The sequence number assigned to the document for the operation.
final BulkResponseItem.Builder	shards(ShardStatistics value)	Shard information for the operation.
final BulkResponseItem.Builder	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Shard information for the operation.
final BulkResponseItem.Builder	status(int value)	Required - The HTTP status code returned for the operation.
final BulkResponseItem.Builder	version(Long value)	The document version associated with the operation.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

operationType

public final BulkResponseItem.Builder operationType(OperationType value)

Required -

id

public final BulkResponseItem.Builder id(@Nullable
 String value)

The document ID associated with the operation.

API name: _id

index

public final BulkResponseItem.Builder index(String value)

Required - The name of the index associated with the operation. If the operation targeted a data stream, this is the backing index into which the document was written.

API name: _index

status

public final BulkResponseItem.Builder status(int value)

Required - The HTTP status code returned for the operation.

API name: status

failureStore

public final BulkResponseItem.Builder failureStore(@Nullable
 FailureStoreStatus value)

API name: failure_store

error

public final BulkResponseItem.Builder error(@Nullable
 ErrorCause value)

Additional information about the failed operation. The property is returned only for failed operations.

API name: error

error

public final BulkResponseItem.Builder error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)

Additional information about the failed operation. The property is returned only for failed operations.

API name: error

primaryTerm

public final BulkResponseItem.Builder primaryTerm(@Nullable
 Long value)

The primary term assigned to the document for the operation. This property is returned only for successful operations.

API name: _primary_term

result

public final BulkResponseItem.Builder result(@Nullable
 String value)

The result of the operation. Successful values are created, deleted, and updated.

API name: result

seqNo

public final BulkResponseItem.Builder seqNo(@Nullable
 Long value)

The sequence number assigned to the document for the operation. Sequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.

API name: _seq_no

shards

public final BulkResponseItem.Builder shards(@Nullable
 ShardStatistics value)

Shard information for the operation.

API name: _shards

shards

public final BulkResponseItem.Builder shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

Shard information for the operation.

API name: _shards

version

public final BulkResponseItem.Builder version(@Nullable
 Long value)

The document version associated with the operation. The document version is incremented each time the document is updated. This property is returned only for successful actions.

API name: _version

forcedRefresh

public final BulkResponseItem.Builder forcedRefresh(@Nullable
 Boolean value)

API name: forced_refresh

get

public final BulkResponseItem.Builder get(@Nullable
 InlineGet<Map<String,JsonData>> value)

API name: get

get

public final BulkResponseItem.Builder get(Function<InlineGet.Builder<Map<String,JsonData>>,ObjectBuilder<InlineGet<Map<String,JsonData>>>> fn)

API name: get

self

protected BulkResponseItem.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<BulkResponseItem.Builder>

build

public BulkResponseItem build()

Builds a BulkResponseItem.

Specified by:

build in interface ObjectBuilder<BulkResponseItem>

Throws:

NullPointerException - if some of the required fields are null.