Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchResponseSections

java.lang.Object

org.elasticsearch.action.search.SearchResponseSections

All Implemented Interfaces:

RefCounted

public class SearchResponseSections
extends Object
implements RefCounted

Holds some sections that a search response is composed of (hits, aggs, suggestions etc.) during some steps of the search response building.

Field Summary

Fields

Modifier and Type	Field	Description
protected final InternalAggregations	aggregations
static final SearchResponseSections	EMPTY_WITH_TOTAL_HITS
static final SearchResponseSections	EMPTY_WITHOUT_TOTAL_HITS
protected final SearchHits	hits
protected final int	numReducePhases
protected final SearchProfileResults	profileResults
protected final Suggest	suggest
protected final Boolean	terminatedEarly
protected final boolean	timedOut

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
SearchResponseSections(SearchHits hits, InternalAggregations aggregations, Suggest suggest, boolean timedOut, Boolean terminatedEarly, SearchProfileResults profileResults, int numReducePhases)

Method Summary

Modifier and Type	Method	Description
boolean	decRef()
boolean	hasReferences()
final SearchHits	hits()
void	incRef()
final Map<String,SearchProfileShardResult>	profile()	Returns the profile results for this search response (including all shards).
final Suggest	suggest()
boolean	tryIncRef()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Field Details

EMPTY_WITH_TOTAL_HITS

public static final SearchResponseSections EMPTY_WITH_TOTAL_HITS

EMPTY_WITHOUT_TOTAL_HITS

public static final SearchResponseSections EMPTY_WITHOUT_TOTAL_HITS

hits

protected final SearchHits hits

aggregations

protected final InternalAggregations aggregations

suggest

protected final Suggest suggest

profileResults

protected final SearchProfileResults profileResults

timedOut

protected final boolean timedOut

terminatedEarly

protected final Boolean terminatedEarly

numReducePhases

protected final int numReducePhases

Constructor Details

SearchResponseSections

public SearchResponseSections(SearchHits hits,
 InternalAggregations aggregations,
 Suggest suggest,
 boolean timedOut,
 Boolean terminatedEarly,
 SearchProfileResults profileResults,
 int numReducePhases)

Method Details

hits

public final SearchHits hits()

suggest

public final Suggest suggest()

profile

public final Map<String,SearchProfileShardResult> profile()

Returns the profile results for this search response (including all shards). An empty map is returned if profiling was not enabled

Returns:

Profile results

incRef

public void incRef()

Specified by:

incRef in interface RefCounted

tryIncRef

public boolean tryIncRef()

Specified by:

tryIncRef in interface RefCounted

decRef

public boolean decRef()

Specified by:

decRef in interface RefCounted

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface RefCounted