Package co.elastic.clients.elasticsearch.core.search

Class ResponseBody<TDocument>

java.lang.Object

co.elastic.clients.elasticsearch.core.search.ResponseBody<TDocument>

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

MultiSearchItem, ScrollResponse, SearchResponse

public abstract class ResponseBody<TDocument>
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ResponseBody.AbstractBuilder<TDocument,BuilderT extends ResponseBody.AbstractBuilder<TDocument,BuilderT>>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Map<String,Aggregate>	aggregations()	API name: aggregations
final ClusterStatistics	clusters()	API name: _clusters
final Map<String,JsonData>	fields()	API name: fields
final HitsMetadata<TDocument>	hits()	Required - API name: hits
final Double	maxScore()	API name: max_score
final Long	numReducePhases()	API name: num_reduce_phases
final String	pitId()	API name: pit_id
final Profile	profile()	API name: profile
final String	scrollId()	API name: _scroll_id
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 ResponseBody.AbstractBuilder<TDocument, BuilderT>> void	setupResponseBodyDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
final ShardStatistics	shards()	Required - API name: _shards
final Map<String,List<Suggestion<TDocument>>>	suggest()	API name: suggest
final Boolean	terminatedEarly()	API name: terminated_early
final boolean	timedOut()	Required - API name: timed_out
final long	took()	Required - API name: took
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseBody

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

Method Details

took

public final long took()

Required - API name: took

timedOut

public final boolean timedOut()

Required - API name: timed_out

shards

public final ShardStatistics shards()

Required - API name: _shards

hits

public final HitsMetadata<TDocument> hits()

Required - API name: hits

aggregations

public final Map<String,Aggregate> aggregations()

API name: aggregations

clusters

@Nullable
public final ClusterStatistics clusters()

API name: _clusters

fields

public final Map<String,JsonData> fields()

API name: fields

maxScore

@Nullable
public final Double maxScore()

API name: max_score

numReducePhases

@Nullable
public final Long numReducePhases()

API name: num_reduce_phases

profile

@Nullable
public final Profile profile()

API name: profile

pitId

@Nullable
public final String pitId()

API name: pit_id

scrollId

@Nullable
public final String scrollId()

API name: _scroll_id

suggest

public final Map<String,List<Suggestion<TDocument>>> suggest()

API name: suggest

terminatedEarly

@Nullable
public final Boolean terminatedEarly()

API name: terminated_early

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)

toString

public String toString()

Overrides:

toString in class Object

setupResponseBodyDeserializer

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