Package org.opensearch.client.opensearch.core.get

Class GetResult<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.get.GetResult<TDocument>

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

GetResponse

public class GetResult<TDocument>
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetResult.AbstractBuilder<TDocument,BuilderT extends GetResult.AbstractBuilder<TDocument,BuilderT>>
static class	GetResult.Builder<TDocument>	Builder for GetResult.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetResult(GetResult.AbstractBuilder<TDocument,?> builder)

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<GetResult<TDocument>>	createGetResultDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for GetResult
final Map<String,JsonData>	fields()	API name: fields
final boolean	found()	Required - API name: found
static <TDocument> GetResult<TDocument>	getResultOf(Function<GetResult.Builder<TDocument>,ObjectBuilder<GetResult<TDocument>>> fn)
final String	id()	Required - API name: _id
final String	index()	Required - API name: _index
final Long	primaryTerm()	API name: _primary_term
final String	routing()	API name: _routing
final Long	seqNo()	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 <TDocument, BuilderT extends GetResult.AbstractBuilder<TDocument, BuilderT>> void	setupGetResultDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
final TDocument	source()	API name: _source
final Long	version()	API name: _version

Methods inherited from class java.lang.Object

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

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

toJsonString

Constructor Details

GetResult

protected GetResult(GetResult.AbstractBuilder<TDocument,?> builder)

Method Details

getResultOf

public static <TDocument> GetResult<TDocument> getResultOf(Function<GetResult.Builder<TDocument>,ObjectBuilder<GetResult<TDocument>>> fn)

index

public final String index()

Required - API name: _index

fields

public final Map<String,JsonData> fields()

API name: fields

found

public final boolean found()

Required - API name: found

id

public final String id()

Required - API name: _id

primaryTerm

@Nullable
public final Long primaryTerm()

API name: _primary_term

routing

@Nullable
public final String routing()

API name: _routing

seqNo

@Nullable
public final Long seqNo()

API name: _seq_no

source

@Nullable
public final TDocument source()

API name: _source

version

@Nullable
public final Long version()

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)

createGetResultDeserializer

public static <TDocument>
JsonpDeserializer<GetResult<TDocument>> createGetResultDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for GetResult

setupGetResultDeserializer

protected static <TDocument,
BuilderT extends GetResult.AbstractBuilder<TDocument,
BuilderT>>
void setupGetResultDeserializer(ObjectDeserializer<BuilderT> op,
 JsonpDeserializer<TDocument> tDocumentDeserializer)