Package org.opensearch.client.opensearch._types

Class WriteResponseBase

java.lang.Object

org.opensearch.client.opensearch._types.WriteResponseBase

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

CreateResponse, DeleteAgentResponse, DeleteConnectorResponse, DeleteControllerResponse, DeleteModelGroupResponse, DeleteModelResponse, DeleteResponse, DeleteTaskResponse, IndexResponse, UpdateConnectorResponse, UpdateControllerResponse, UpdateMemoryResponse, UpdateMessageResponse, UpdateModelResponse, UpdateResponse

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class WriteResponseBase
extends Object
implements PlainJsonSerializable

The base response for write operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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
boolean	equals(Object o)
final Boolean	forcedRefresh()	API name: forced_refresh
int	hashCode()
final String	id()	Required - API name: _id
final String	index()	Required - API name: _index
final long	primaryTerm()	Required - The primary term of the document.
final Result	result()	Required - API name: result
final 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)
final ShardStatistics	shards()	Required - API name: _shards
final long	version()	Required - API name: _version

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Constructor Details

WriteResponseBase

protected WriteResponseBase(WriteResponseBase.AbstractBuilder<?> builder)

Method Details

forcedRefresh

@Nullable
public final Boolean forcedRefresh()

API name: forced_refresh

id

@Nonnull
public final String id()

Required - API name: _id

index

@Nonnull
public final String index()

Required - API name: _index

primaryTerm

public final long primaryTerm()

Required - The primary term of the document.

API name: _primary_term

result

@Nonnull
public final Result result()

Required - API name: result

seqNo

public final long seqNo()

Required - API name: _seq_no

shards

@Nonnull
public final ShardStatistics shards()

Required - API name: _shards

version

public final long version()

Required - API name: _version

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)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object