Package co.elastic.clients.elasticsearch._types.aggregations

Class TopHitsAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder<TopHitsAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.TopHitsAggregation.Builder

All Implemented Interfaces:

WithJson<TopHitsAggregation.Builder>, ObjectBuilder<TopHitsAggregation>

Enclosing class:

TopHitsAggregation

public static class TopHitsAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<TopHitsAggregation.Builder>
implements ObjectBuilder<TopHitsAggregation>

Builder for TopHitsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopHitsAggregation	build()	Builds a TopHitsAggregation.
final TopHitsAggregation.Builder	docvalueFields(String value, String... values)	Fields for which to return doc values.
final TopHitsAggregation.Builder	docvalueFields(List<String> list)	Fields for which to return doc values.
final TopHitsAggregation.Builder	explain(Boolean value)	If true, returns detailed information about score computation as part of a hit.
final TopHitsAggregation.Builder	from(Integer value)	Starting document offset.
final TopHitsAggregation.Builder	highlight(Highlight value)	Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.
final TopHitsAggregation.Builder	highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.
final TopHitsAggregation.Builder	scriptFields(String key, ScriptField value)	Returns the result of one or more script evaluations for each hit.
final TopHitsAggregation.Builder	scriptFields(String key, Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	Returns the result of one or more script evaluations for each hit.
final TopHitsAggregation.Builder	scriptFields(Map<String,ScriptField> map)	Returns the result of one or more script evaluations for each hit.
protected TopHitsAggregation.Builder	self()
final TopHitsAggregation.Builder	seqNoPrimaryTerm(Boolean value)	If true, returns sequence number and primary term of the last modification of each hit.
final TopHitsAggregation.Builder	size(Integer value)	The maximum number of top matching hits to return per bucket.
final TopHitsAggregation.Builder	sort(SortOptions value, SortOptions... values)	Sort order of the top matching hits.
final TopHitsAggregation.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	Sort order of the top matching hits.
final TopHitsAggregation.Builder	sort(List<SortOptions> list)	Sort order of the top matching hits.
final TopHitsAggregation.Builder	source(SourceConfig value)	Selects the fields of the source that are returned.
final TopHitsAggregation.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	Selects the fields of the source that are returned.
final TopHitsAggregation.Builder	storedFields(String value, String... values)	Returns values for the specified stored fields (fields that use the store mapping option).
final TopHitsAggregation.Builder	storedFields(List<String> list)	Returns values for the specified stored fields (fields that use the store mapping option).
final TopHitsAggregation.Builder	trackScores(Boolean value)	If true, calculates and returns document scores, even if the scores are not used for sorting.
final TopHitsAggregation.Builder	version(Boolean value)	If true, returns document version as part of a hit.

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder

field, missing, missing, missing, missing, missing, missing, script, script

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

docvalueFields

public final TopHitsAggregation.Builder docvalueFields(List<String> list)

Fields for which to return doc values.

API name: docvalue_fields

Adds all elements of list to docvalueFields.

docvalueFields

public final TopHitsAggregation.Builder docvalueFields(String value,
 String... values)

Fields for which to return doc values.

API name: docvalue_fields

Adds one or more values to docvalueFields.

explain

public final TopHitsAggregation.Builder explain(@Nullable
 Boolean value)

If true, returns detailed information about score computation as part of a hit.

API name: explain

from

public final TopHitsAggregation.Builder from(@Nullable
 Integer value)

Starting document offset.

API name: from

highlight

public final TopHitsAggregation.Builder highlight(@Nullable
 Highlight value)

Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.

API name: highlight

highlight

public final TopHitsAggregation.Builder highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)

Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.

API name: highlight

scriptFields

public final TopHitsAggregation.Builder scriptFields(Map<String,ScriptField> map)

Returns the result of one or more script evaluations for each hit.

API name: script_fields

Adds all entries of map to scriptFields.

scriptFields

public final TopHitsAggregation.Builder scriptFields(String key,
 ScriptField value)

Returns the result of one or more script evaluations for each hit.

API name: script_fields

Adds an entry to scriptFields.

scriptFields

public final TopHitsAggregation.Builder scriptFields(String key,
 Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

Returns the result of one or more script evaluations for each hit.

API name: script_fields

Adds an entry to scriptFields using a builder lambda.

size

public final TopHitsAggregation.Builder size(@Nullable
 Integer value)

The maximum number of top matching hits to return per bucket.

API name: size

sort

public final TopHitsAggregation.Builder sort(List<SortOptions> list)

Sort order of the top matching hits. By default, the hits are sorted by the score of the main query.

API name: sort

Adds all elements of list to sort.

sort

public final TopHitsAggregation.Builder sort(SortOptions value,
 SortOptions... values)

Sort order of the top matching hits. By default, the hits are sorted by the score of the main query.

API name: sort

Adds one or more values to sort.

sort

public final TopHitsAggregation.Builder sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

Sort order of the top matching hits. By default, the hits are sorted by the score of the main query.

API name: sort

Adds a value to sort using a builder lambda.

source

public final TopHitsAggregation.Builder source(@Nullable
 SourceConfig value)

Selects the fields of the source that are returned.

API name: _source

source

public final TopHitsAggregation.Builder source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)

Selects the fields of the source that are returned.

API name: _source

storedFields

public final TopHitsAggregation.Builder storedFields(List<String> list)

Returns values for the specified stored fields (fields that use the store mapping option).

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

public final TopHitsAggregation.Builder storedFields(String value,
 String... values)

Returns values for the specified stored fields (fields that use the store mapping option).

API name: stored_fields

Adds one or more values to storedFields.

trackScores

public final TopHitsAggregation.Builder trackScores(@Nullable
 Boolean value)

If true, calculates and returns document scores, even if the scores are not used for sorting.

API name: track_scores

version

public final TopHitsAggregation.Builder version(@Nullable
 Boolean value)

If true, returns document version as part of a hit.

API name: version

seqNoPrimaryTerm

public final TopHitsAggregation.Builder seqNoPrimaryTerm(@Nullable
 Boolean value)

If true, returns sequence number and primary term of the last modification of each hit.

API name: seq_no_primary_term

self

protected TopHitsAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<TopHitsAggregation.Builder>

build

public TopHitsAggregation build()

Builds a TopHitsAggregation.

Specified by:

build in interface ObjectBuilder<TopHitsAggregation>

Throws:

NullPointerException - if some of the required fields are null.