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. Instances must be created with the from(SearchResponse) method.

Since:

4.0

Author:

Peter-Josef Meisch

Method Summary

Modifier and Type	Method and Description
static SearchDocumentResponse	from(org.elasticsearch.search.SearchHits searchHits, String scrollId, org.elasticsearch.search.aggregations.Aggregations aggregations) creates a SearchDocumentResponse from SearchHits with the given scrollId and aggregations
static SearchDocumentResponse	from(org.elasticsearch.action.search.SearchResponse searchResponse) creates a SearchDocumentResponse from the SearchResponse
org.elasticsearch.search.aggregations.Aggregations	getAggregations()
float	getMaxScore()
String	getScrollId()
List<SearchDocument>	getSearchDocuments()
long	getTotalHits()
String	getTotalHitsRelation()

Methods inherited from class java.lang.Object

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

Method Detail

getTotalHits

public long getTotalHits()

getTotalHitsRelation

public String getTotalHitsRelation()

getMaxScore

public float getMaxScore()

getScrollId

public String getScrollId()

getSearchDocuments

public List<SearchDocument> getSearchDocuments()

getAggregations

public org.elasticsearch.search.aggregations.Aggregations getAggregations()

from

public static SearchDocumentResponse from(org.elasticsearch.action.search.SearchResponse searchResponse)

creates a SearchDocumentResponse from the SearchResponse

Parameters:

searchResponse - must not be null

Returns:

the SearchDocumentResponse

from

public static SearchDocumentResponse from(org.elasticsearch.search.SearchHits searchHits,
                                          @Nullable
                                          String scrollId,
                                          @Nullable
                                          org.elasticsearch.search.aggregations.Aggregations aggregations)

creates a SearchDocumentResponse from SearchHits with the given scrollId and aggregations

Parameters:

searchHits - the SearchHits to process

scrollId - scrollId

aggregations - aggregations

Returns:

the SearchDocumentResponse

Since:

4.1