Package org.opensearch.client.opensearch._types

Class WriteResponseBase

java.lang.Object

org.opensearch.client.opensearch._types.WriteResponseBase

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

CreateResponse, DeleteResponse, IndexResponse, UpdateResponse

public abstract class WriteResponseBase
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WriteResponseBase.AbstractBuilder<BuilderT extends WriteResponseBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriteResponseBase(WriteResponseBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	forcedRefresh()	API name: forced_refresh
java.lang.String	id()	Required - API name: _id
java.lang.String	index()	Required - API name: _index
long	primaryTerm()	Required - API name: _primary_term
Result	result()	Required - API name: result
long	seqNo()	Required - API name: _seq_no
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends WriteResponseBase.AbstractBuilder<BuilderT>> void	setupWriteResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)
ShardStatistics	shards()	Required - API name: _shards
long	version()	Required - API name: _version

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteResponseBase

protected WriteResponseBase(WriteResponseBase.AbstractBuilder<?> builder)

Method Detail

id

public final java.lang.String id()

Required - API name: _id

index

public final java.lang.String index()

Required - API name: _index

primaryTerm

public final long primaryTerm()

Required - API name: _primary_term

result

public final Result result()

Required - API name: result

seqNo

public final long seqNo()

Required - API name: _seq_no

shards

public final ShardStatistics shards()

Required - API name: _shards

version

public final long version()

Required - API name: _version

forcedRefresh

@Nullable
public final java.lang.Boolean forcedRefresh()

API name: forced_refresh

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupWriteResponseBaseDeserializer

protected static <BuilderT extends WriteResponseBase.AbstractBuilder<BuilderT>> void setupWriteResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)