Package org.elasticsearch.search

Enum Class SearchResponseUtils

java.lang.Object

java.lang.Enum<SearchResponseUtils>

org.elasticsearch.search.SearchResponseUtils

All Implemented Interfaces:

Serializable, Comparable<SearchResponseUtils>, Constable

public enum SearchResponseUtils
extends Enum<SearchResponseUtils>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResponseUtils.SearchResponseBuilder

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Field Summary

Fields

Modifier and Type	Field	Description
static final ObjectParser.UnknownFieldConsumer<Map<String,Object>>	unknownMetaFieldConsumer

Method Summary

Modifier and Type	Method	Description
static void	declareInnerHitsParseFields(ObjectParser<Map<String,Object>,Void> parser)
static SearchResponse	emptyWithTotalHits(String scrollId, int totalShards, int successfulShards, int skippedShards, long tookInMillis, ShardSearchFailure[] shardFailures, SearchResponse.Clusters clusters)
static org.apache.lucene.search.TotalHits	getTotalHits(SearchRequestBuilder request)
static long	getTotalHitsValue(SearchRequestBuilder request)
static CollectorResult	parseCollectorResult(XContentParser parser)
static HighlightField	parseHighlightField(XContentParser parser)
static SearchResponse	parseInnerSearchResponse(XContentParser parser)
static MultiSearchResponse	parseMultiSearchResponse(XContentParser parser)
static SearchHit.NestedIdentity	parseNestedIdentity(XContentParser parser)
static SearchProfileDfsPhaseResult	parseProfileDfsPhaseResult(XContentParser parser)
static ProfileResult	parseProfileResult(XContentParser p)
static QueryProfileShardResult	parseQueryProfileShardResult(XContentParser parser)
static SearchHit	parseSearchHit(XContentParser parser)	Parses a single search hit from XContent into a ref-counted SearchHit.
static SearchHits	parseSearchHits(XContentParser parser)	Parses search hits from XContent into a ref-counted SearchHits.
static SearchProfileResults	parseSearchProfileResults(XContentParser parser)
static SearchResponse	parseSearchResponse(XContentParser parser)
static SearchSortValues	parseSearchSortValues(XContentParser parser)
static ShardSearchFailure	parseShardSearchFailure(XContentParser parser)
static Suggest	parseSuggest(XContentParser parser)	this parsing method assumes that the leading "suggest" field name has already been parsed by the caller
static Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>>	parseSuggestion(XContentParser parser)
static AggregationProfileShardResult	readAggregationProfileShardResult(XContentParser parser)
static SearchResponseUtils.SearchResponseBuilder	response()
static SearchResponseUtils.SearchResponseBuilder	response(SearchHits hits)
static SearchResponse	responseAsSearchResponse(Response searchResponse)
static SearchHit	searchHitFromMap(Map<String,Object> values)
static SearchResponse	successfulResponse(SearchHits hits)
static SearchResponseUtils	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchResponseUtils[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

unknownMetaFieldConsumer

public static final ObjectParser.UnknownFieldConsumer<Map<String,Object>> unknownMetaFieldConsumer

Method Details

values

public static SearchResponseUtils[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SearchResponseUtils valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

response

public static SearchResponseUtils.SearchResponseBuilder response()

response

public static SearchResponseUtils.SearchResponseBuilder response(SearchHits hits)

successfulResponse

public static SearchResponse successfulResponse(SearchHits hits)

emptyWithTotalHits

public static SearchResponse emptyWithTotalHits(String scrollId,
 int totalShards,
 int successfulShards,
 int skippedShards,
 long tookInMillis,
 ShardSearchFailure[] shardFailures,
 SearchResponse.Clusters clusters)

getTotalHits

public static org.apache.lucene.search.TotalHits getTotalHits(SearchRequestBuilder request)

getTotalHitsValue

public static long getTotalHitsValue(SearchRequestBuilder request)

responseAsSearchResponse

public static SearchResponse responseAsSearchResponse(Response searchResponse)
                                               throws IOException

Throws:

IOException

parseSearchResponse

public static SearchResponse parseSearchResponse(XContentParser parser)
                                          throws IOException

Throws:

IOException

parseMultiSearchResponse

public static MultiSearchResponse parseMultiSearchResponse(XContentParser parser)

parseInnerSearchResponse

public static SearchResponse parseInnerSearchResponse(XContentParser parser)
                                               throws IOException

Throws:

IOException

parseSearchProfileResults

public static SearchProfileResults parseSearchProfileResults(XContentParser parser)
                                                      throws IOException

Throws:

IOException

parseProfileDfsPhaseResult

public static SearchProfileDfsPhaseResult parseProfileDfsPhaseResult(XContentParser parser)
                                                              throws IOException

Throws:

IOException

parseQueryProfileShardResult

public static QueryProfileShardResult parseQueryProfileShardResult(XContentParser parser)
                                                            throws IOException

Throws:

IOException

parseSearchHits

public static SearchHits parseSearchHits(XContentParser parser)
                                  throws IOException

Parses search hits from XContent into a ref-counted SearchHits. Callers must SearchHits.decRef() when done.

Throws:

IOException

parseSearchHit

public static SearchHit parseSearchHit(XContentParser parser)

Parses a single search hit from XContent into a ref-counted SearchHit. Callers must SearchHit.decRef() when done.

declareInnerHitsParseFields

public static void declareInnerHitsParseFields(ObjectParser<Map<String,Object>,Void> parser)

parseSuggest

public static Suggest parseSuggest(XContentParser parser)
                            throws IOException

this parsing method assumes that the leading "suggest" field name has already been parsed by the caller

Throws:

IOException

parseSuggestion

public static Suggest.Suggestion<? extends Suggest.Suggestion.Entry<? extends Suggest.Suggestion.Entry.Option>> parseSuggestion(XContentParser parser)
                                                                                                                         throws IOException

Throws:

IOException

parseNestedIdentity

public static SearchHit.NestedIdentity parseNestedIdentity(XContentParser parser)

searchHitFromMap

public static SearchHit searchHitFromMap(Map<String,Object> values)

readAggregationProfileShardResult

public static AggregationProfileShardResult readAggregationProfileShardResult(XContentParser parser)
                                                                       throws IOException

Throws:

IOException

parseCollectorResult

public static CollectorResult parseCollectorResult(XContentParser parser)
                                            throws IOException

Throws:

IOException

parseHighlightField

public static HighlightField parseHighlightField(XContentParser parser)
                                          throws IOException

Throws:

IOException

parseProfileResult

public static ProfileResult parseProfileResult(XContentParser p)
                                        throws IOException

Throws:

IOException

parseSearchSortValues

public static SearchSortValues parseSearchSortValues(XContentParser parser)
                                              throws IOException

Throws:

IOException

parseShardSearchFailure

public static ShardSearchFailure parseShardSearchFailure(XContentParser parser)
                                                  throws IOException

Throws:

IOException