Package org.opensearch.search.aggregations.metrics

Class TopHitsAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

org.opensearch.search.aggregations.AbstractAggregationBuilder<TopHitsAggregationBuilder>

org.opensearch.search.aggregations.metrics.TopHitsAggregationBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class TopHitsAggregationBuilder
extends AbstractAggregationBuilder<TopHitsAggregationBuilder>

Aggregation Builder for top_hits agg

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

metadata

Fields inherited from class org.opensearch.search.aggregations.AggregationBuilder

factoriesBuilder, name

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	TopHitsAggregationBuilder(String name)
	TopHitsAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.
protected	TopHitsAggregationBuilder(TopHitsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected org.opensearch.search.aggregations.metrics.TopHitsAggregatorFactory	doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder)
TopHitsAggregationBuilder	docValueField(String docValueField)	Adds a field to load from doc values and return as part of the search request.
TopHitsAggregationBuilder	docValueField(String docValueField, String format)	Adds a field to load from doc values and return as part of the search request.
List<FieldAndFormat>	docValueFields()	Gets the field-data fields.
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
boolean	equals(Object o)
boolean	explain()	Indicates whether each search hit will be returned with an explanation of the hit (ranking)
TopHitsAggregationBuilder	explain(boolean explain)	Should each SearchHit be returned with an explanation of the hit (ranking).
TopHitsAggregationBuilder	fetchField(String field)	Adds a field to load and return as part of the search request.
TopHitsAggregationBuilder	fetchField(String field, String format)	Adds a field to load and return as part of the search request.
List<FieldAndFormat>	fetchFields()	Gets the fields to load and return as part of the search request.
FetchSourceContext	fetchSource()	Gets the FetchSourceContext which defines how the _source should be fetched.
TopHitsAggregationBuilder	fetchSource(boolean fetch)	Indicates whether the response should contain the stored _source for every hit
TopHitsAggregationBuilder	fetchSource(String[] includes, String[] excludes)	Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
TopHitsAggregationBuilder	fetchSource(String include, String exclude)	Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
TopHitsAggregationBuilder	fetchSource(FetchSourceContext fetchSourceContext)	Indicate how the _source should be fetched.
int	from()	Gets the from index to start the search from.
TopHitsAggregationBuilder	from(int from)	From index to start the search from.
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
HighlightBuilder	highlighter()	Gets the highlighter builder for this request.
TopHitsAggregationBuilder	highlighter(HighlightBuilder highlightBuilder)	Adds highlight to perform as part of the search.
protected org.opensearch.core.xcontent.XContentBuilder	internalXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static TopHitsAggregationBuilder	parse(String aggregationName, org.opensearch.core.xcontent.XContentParser parser)
TopHitsAggregationBuilder	scriptField(String name, Script script)	Adds a script field under the given name with the provided script.
TopHitsAggregationBuilder	scriptField(String name, Script script, boolean ignoreFailure)	Adds a script field under the given name with the provided script.
Set<SearchSourceBuilder.ScriptField>	scriptFields()	Gets the script fields.
TopHitsAggregationBuilder	scriptFields(List<SearchSourceBuilder.ScriptField> scriptFields)
Boolean	seqNoAndPrimaryTerm()	Indicates whether SearchHits should be returned with the sequence number and primary term of the last modification of the document.
TopHitsAggregationBuilder	seqNoAndPrimaryTerm(Boolean seqNoAndPrimaryTerm)	Should each SearchHit be returned with the sequence number and primary term of the last modification of the document.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
int	size()	Gets the number of search hits to return.
TopHitsAggregationBuilder	size(int size)	The number of search hits to return.
TopHitsAggregationBuilder	sort(String name)	Add a sort against the given field name.
TopHitsAggregationBuilder	sort(String name, SortOrder order)	Adds a sort against the given field name and the sort ordering.
TopHitsAggregationBuilder	sort(SortBuilder<?> sort)	Adds a sort builder.
List<SortBuilder<?>>	sorts()	Gets the bytes representing the sort builders for this request.
TopHitsAggregationBuilder	sorts(List<SortBuilder<?>> sorts)	Adds a sort builder.
TopHitsAggregationBuilder	storedField(String field)	Adds a stored field to load and return (note, it must be stored) as part of the search request.
StoredFieldsContext	storedFields()	Gets the stored fields context
TopHitsAggregationBuilder	storedFields(List<String> fields)	Sets the stored fields to load and return as part of the search request.
TopHitsAggregationBuilder	subAggregations(AggregatorFactories.Builder subFactories)	Registers sub-factories with this factory.
boolean	trackScores()	Indicates whether scores will be tracked for this request.
TopHitsAggregationBuilder	trackScores(boolean trackScores)	Applies when sorting, and controls if scores will be tracked as well.
boolean	version()	Indicates whether the document's version will be included in the search hits.
TopHitsAggregationBuilder	version(boolean version)	Should each SearchHit be returned with a version associated with it.

Methods inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, toXContent, writeTo

Methods inherited from class org.opensearch.search.aggregations.AggregationBuilder

buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TopHitsAggregationBuilder

public TopHitsAggregationBuilder(String name)

TopHitsAggregationBuilder

protected TopHitsAggregationBuilder(TopHitsAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

TopHitsAggregationBuilder

public TopHitsAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                          throws IOException

Read from a stream.

Throws:

IOException

Method Details

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<TopHitsAggregationBuilder>

Throws:

IOException

from

public TopHitsAggregationBuilder from(int from)

From index to start the search from. Defaults to 0.

from

public int from()

Gets the from index to start the search from.

size

public TopHitsAggregationBuilder size(int size)

The number of search hits to return. Defaults to 10.

size

public int size()

Gets the number of search hits to return.

sort

public TopHitsAggregationBuilder sort(String name,
 SortOrder order)

Adds a sort against the given field name and the sort ordering.

Parameters:

name - The name of the field

order - The sort ordering

sort

public TopHitsAggregationBuilder sort(String name)

Add a sort against the given field name.

Parameters:

name - The name of the field to sort by

sort

public TopHitsAggregationBuilder sort(SortBuilder<?> sort)

Adds a sort builder.

sorts

public TopHitsAggregationBuilder sorts(List<SortBuilder<?>> sorts)

Adds a sort builder.

sorts

public List<SortBuilder<?>> sorts()

Gets the bytes representing the sort builders for this request.

highlighter

public TopHitsAggregationBuilder highlighter(HighlightBuilder highlightBuilder)

Adds highlight to perform as part of the search.

highlighter

public HighlightBuilder highlighter()

Gets the highlighter builder for this request.

fetchSource

public TopHitsAggregationBuilder fetchSource(boolean fetch)

Indicates whether the response should contain the stored _source for every hit

fetchSource

public TopHitsAggregationBuilder fetchSource(@Nullable
 String include,
 @Nullable
 String exclude)

Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

include - An optional include (optionally wildcarded) pattern to filter the returned _source

exclude - An optional exclude (optionally wildcarded) pattern to filter the returned _source

fetchSource

public TopHitsAggregationBuilder fetchSource(@Nullable
 String[] includes,
 @Nullable
 String[] excludes)

Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

includes - An optional list of include (optionally wildcarded) pattern to filter the returned _source

excludes - An optional list of exclude (optionally wildcarded) pattern to filter the returned _source

fetchSource

public TopHitsAggregationBuilder fetchSource(@Nullable
 FetchSourceContext fetchSourceContext)

Indicate how the _source should be fetched.

fetchSource

public FetchSourceContext fetchSource()

Gets the FetchSourceContext which defines how the _source should be fetched.

storedField

public TopHitsAggregationBuilder storedField(String field)

Adds a stored field to load and return (note, it must be stored) as part of the search request. To disable the stored fields entirely (source and metadata fields) use storedField("_none_").

storedFields

public TopHitsAggregationBuilder storedFields(List<String> fields)

Sets the stored fields to load and return as part of the search request. To disable the stored fields entirely (source and metadata fields) use storedField("_none_").

storedFields

public StoredFieldsContext storedFields()

Gets the stored fields context

docValueField

public TopHitsAggregationBuilder docValueField(String docValueField,
 String format)

Adds a field to load from doc values and return as part of the search request.

docValueField

public TopHitsAggregationBuilder docValueField(String docValueField)

Adds a field to load from doc values and return as part of the search request.

docValueFields

public List<FieldAndFormat> docValueFields()

Gets the field-data fields.

fetchField

public TopHitsAggregationBuilder fetchField(String field,
 String format)

Adds a field to load and return as part of the search request.

fetchField

public TopHitsAggregationBuilder fetchField(String field)

Adds a field to load and return as part of the search request.

fetchFields

public List<FieldAndFormat> fetchFields()

Gets the fields to load and return as part of the search request.

scriptField

public TopHitsAggregationBuilder scriptField(String name,
 Script script)

Adds a script field under the given name with the provided script.

Parameters:

name - The name of the field

script - The script

scriptField

public TopHitsAggregationBuilder scriptField(String name,
 Script script,
 boolean ignoreFailure)

Adds a script field under the given name with the provided script.

Parameters:

name - The name of the field

script - The script

scriptFields

public TopHitsAggregationBuilder scriptFields(List<SearchSourceBuilder.ScriptField> scriptFields)

scriptFields

public Set<SearchSourceBuilder.ScriptField> scriptFields()

Gets the script fields.

explain

public TopHitsAggregationBuilder explain(boolean explain)

Should each SearchHit be returned with an explanation of the hit (ranking).

explain

public boolean explain()

Indicates whether each search hit will be returned with an explanation of the hit (ranking)

version

public TopHitsAggregationBuilder version(boolean version)

Should each SearchHit be returned with a version associated with it.

version

public boolean version()

Indicates whether the document's version will be included in the search hits.

seqNoAndPrimaryTerm

public TopHitsAggregationBuilder seqNoAndPrimaryTerm(Boolean seqNoAndPrimaryTerm)

Should each SearchHit be returned with the sequence number and primary term of the last modification of the document.

seqNoAndPrimaryTerm

public Boolean seqNoAndPrimaryTerm()

Indicates whether SearchHits should be returned with the sequence number and primary term of the last modification of the document.

trackScores

public TopHitsAggregationBuilder trackScores(boolean trackScores)

Applies when sorting, and controls if scores will be tracked as well. Defaults to false.

trackScores

public boolean trackScores()

Indicates whether scores will be tracked for this request.

subAggregations

public TopHitsAggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)

Description copied from class: AbstractAggregationBuilder

Registers sub-factories with this factory. The sub-factory will be responsible for the creation of sub-aggregators under the aggregator created by this factory.

Specified by:

subAggregations in interface BaseAggregationBuilder

Overrides:

subAggregations in class AbstractAggregationBuilder<TopHitsAggregationBuilder>

Parameters:

subFactories - The sub-factories

Returns:

this factory (fluent interface)

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

doBuild

protected org.opensearch.search.aggregations.metrics.TopHitsAggregatorFactory doBuild(QueryShardContext queryShardContext,
 AggregatorFactory parent,
 AggregatorFactories.Builder subfactoriesBuilder)
                                                                               throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<TopHitsAggregationBuilder>

Throws:

IOException

internalXContent

protected org.opensearch.core.xcontent.XContentBuilder internalXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                 throws IOException

Specified by:

internalXContent in class AbstractAggregationBuilder<TopHitsAggregationBuilder>

Throws:

IOException

parse

public static TopHitsAggregationBuilder parse(String aggregationName,
 org.opensearch.core.xcontent.XContentParser parser)
                                       throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractAggregationBuilder<TopHitsAggregationBuilder>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<TopHitsAggregationBuilder>

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.