Class SearchDocumentResponse

java.lang.Object

org.springframework.data.elasticsearch.core.document.SearchDocumentResponse

public class SearchDocumentResponse
extends Object

This represents the complete search response from Elasticsearch, including the returned documents.

Since:

4.0

Author:

Peter-Josef Meisch, Haibo Liu, Mohamed El Harrougui

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchDocumentResponse.EntityCreator<T>	A function to convert a SearchDocument async into an entity.

Constructor Summary

Constructors

Constructor	Description
SearchDocumentResponse(long totalHits, String totalHitsRelation, float maxScore, Duration executionDuration, @Nullable String scrollId, @Nullable String pointInTimeId, List<SearchDocument> searchDocuments, @Nullable AggregationsContainer<?> aggregationsContainer, @Nullable Suggest suggest, @Nullable SearchShardStatistics searchShardStatistics)

Method Summary

Modifier and Type	Method	Description
@Nullable AggregationsContainer<?>	getAggregations()
Duration	getExecutionDuration()
float	getMaxScore()
@Nullable String	getPointInTimeId()
@Nullable String	getScrollId()
List<SearchDocument>	getSearchDocuments()
@Nullable SearchShardStatistics	getSearchShardStatistics()
@Nullable Suggest	getSuggest()
long	getTotalHits()
String	getTotalHitsRelation()

Methods inherited from class Object

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

Constructor Details

SearchDocumentResponse

public SearchDocumentResponse(long totalHits,
 String totalHitsRelation,
 float maxScore,
 Duration executionDuration,
 @Nullable String scrollId,
 @Nullable String pointInTimeId,
 List<SearchDocument> searchDocuments,
 @Nullable AggregationsContainer<?> aggregationsContainer,
 @Nullable Suggest suggest,
 @Nullable SearchShardStatistics searchShardStatistics)

Method Details

getTotalHits

public long getTotalHits()

getTotalHitsRelation

public String getTotalHitsRelation()

getMaxScore

public float getMaxScore()

getExecutionDuration

public Duration getExecutionDuration()

getScrollId

public @Nullable String getScrollId()

getSearchDocuments

public List<SearchDocument> getSearchDocuments()

getAggregations

public @Nullable AggregationsContainer<?> getAggregations()

getSuggest

public @Nullable Suggest getSuggest()

getPointInTimeId

public @Nullable String getPointInTimeId()

Since:

5.0

getSearchShardStatistics

public @Nullable SearchShardStatistics getSearchShardStatistics()