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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aTopHitsAggregation
.docvalueFields
(String value, String... values) API name:docvalue_fields
docvalueFields
(List<String> list) API name:docvalue_fields
API name:explain
API name:from
API name:highlight
API name:highlight
scriptFields
(String key, ScriptField value) API name:script_fields
API name:script_fields
scriptFields
(Map<String, ScriptField> map) API name:script_fields
protected TopHitsAggregation.Builder
self()
seqNoPrimaryTerm
(Boolean value) API name:seq_no_primary_term
API name:size
sort
(SortOptions value, SortOptions... values) API name:sort
API name:sort
sort
(List<SortOptions> list) API name:sort
source
(SourceConfig value) API name:_source
API name:_source
storedFields
(String value, String... values) API name:stored_fields
storedFields
(List<String> list) API name:stored_fields
trackScores
(Boolean value) API name:track_scores
API name:version
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
docvalueFields
API name:docvalue_fields
Adds all elements of
list
todocvalueFields
. -
docvalueFields
API name:docvalue_fields
Adds one or more values to
docvalueFields
. -
explain
API name:explain
-
from
API name:from
-
highlight
API name:highlight
-
highlight
public final TopHitsAggregation.Builder highlight(Function<Highlight.Builder, ObjectBuilder<Highlight>> fn) API name:highlight
-
scriptFields
API name:script_fields
Adds all entries of
map
toscriptFields
. -
scriptFields
API name:script_fields
Adds an entry to
scriptFields
. -
scriptFields
public final TopHitsAggregation.Builder scriptFields(String key, Function<ScriptField.Builder, ObjectBuilder<ScriptField>> fn) API name:script_fields
Adds an entry to
scriptFields
using a builder lambda. -
size
API name:size
-
sort
API name:sort
Adds all elements of
list
tosort
. -
sort
API name:sort
Adds one or more values to
sort
. -
sort
public final TopHitsAggregation.Builder sort(Function<SortOptions.Builder, ObjectBuilder<SortOptions>> fn) API name:sort
Adds a value to
sort
using a builder lambda. -
source
API name:_source
-
source
public final TopHitsAggregation.Builder source(Function<SourceConfig.Builder, ObjectBuilder<SourceConfig>> fn) API name:_source
-
storedFields
API name:stored_fields
Adds all elements of
list
tostoredFields
. -
storedFields
API name:stored_fields
Adds one or more values to
storedFields
. -
trackScores
API name:track_scores
-
version
API name:version
-
seqNoPrimaryTerm
API name:seq_no_primary_term
-
self
- Specified by:
self
in classMetricAggregationBase.AbstractBuilder<TopHitsAggregation.Builder>
-
build
Builds aTopHitsAggregation
.- Specified by:
build
in interfaceObjectBuilder<TopHitsAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-