Package org.springframework.data.elasticsearch.core.document

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

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, String scrollId, List<SearchDocument> searchDocuments, AggregationsContainer<?> aggregationsContainer, Suggest suggest)

Method Summary

Modifier and Type	Method	Description
AggregationsContainer<?>	getAggregations()
float	getMaxScore()
String	getScrollId()
List<SearchDocument>	getSearchDocuments()
Suggest	getSuggest()
long	getTotalHits()
String	getTotalHitsRelation()

Methods inherited from class java.lang.Object

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

Constructor Details

SearchDocumentResponse

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

Method Details

getTotalHits

public long getTotalHits()

getTotalHitsRelation

public String getTotalHitsRelation()

getMaxScore

public float getMaxScore()

getScrollId

@Nullable
public String getScrollId()

getSearchDocuments

public List<SearchDocument> getSearchDocuments()

getAggregations

@Nullable
public AggregationsContainer<?> getAggregations()

getSuggest

@Nullable
public Suggest getSuggest()