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, EntityCreator) method.

Since:

4.0

Author:

Peter-Josef Meisch

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static <T> SearchDocumentResponse	from(org.elasticsearch.search.SearchHits searchHits, String scrollId, org.elasticsearch.search.aggregations.Aggregations aggregations, org.elasticsearch.search.suggest.Suggest suggestES, SearchDocumentResponse.EntityCreator<T> entityCreator) creates a SearchDocumentResponse from SearchHits with the given scrollId aggregations and suggest
static <T> SearchDocumentResponse	from(org.elasticsearch.action.search.SearchResponse searchResponse, SearchDocumentResponse.EntityCreator<T> entityCreator) creates a SearchDocumentResponse from the SearchResponse
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

Method Detail

getTotalHits

public long getTotalHits()

getTotalHitsRelation

public String getTotalHitsRelation()

getMaxScore

public float getMaxScore()

getScrollId

public String getScrollId()

getSearchDocuments

public List<SearchDocument> getSearchDocuments()

getAggregations

@Nullable
public AggregationsContainer<?> getAggregations()

getSuggest

@Nullable
public Suggest getSuggest()

from

public static <T> SearchDocumentResponse from(org.elasticsearch.action.search.SearchResponse searchResponse,
                                              SearchDocumentResponse.EntityCreator<T> entityCreator)

creates a SearchDocumentResponse from the SearchResponse

Type Parameters:

T - entity type

Parameters:

searchResponse - must not be null

entityCreator - function to create an entity from a SearchDocument

Returns:

the SearchDocumentResponse

from

public static <T> SearchDocumentResponse from(org.elasticsearch.search.SearchHits searchHits,
                                              @Nullable
                                              String scrollId,
                                              @Nullable
                                              org.elasticsearch.search.aggregations.Aggregations aggregations,
                                              @Nullable
                                              org.elasticsearch.search.suggest.Suggest suggestES,
                                              SearchDocumentResponse.EntityCreator<T> entityCreator)

creates a SearchDocumentResponse from SearchHits with the given scrollId aggregations and suggest

Type Parameters:

T - entity type

Parameters:

searchHits - the SearchHits to process

scrollId - scrollId

aggregations - aggregations

suggestES - the suggestion response from Elasticsearch

entityCreator - function to create an entity from a SearchDocument

Returns:

the SearchDocumentResponse

Since:

4.3