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)	API name: docvalue_fields
final TopHitsAggregation.Builder	docvalueFields(List<String> list)	API name: docvalue_fields
final TopHitsAggregation.Builder	explain(Boolean value)	API name: explain
final TopHitsAggregation.Builder	from(Integer value)	API name: from
final TopHitsAggregation.Builder	highlight(Highlight value)	API name: highlight
final TopHitsAggregation.Builder	highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
final TopHitsAggregation.Builder	scriptFields(String key, ScriptField value)	API name: script_fields
final TopHitsAggregation.Builder	scriptFields(String key, Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	API name: script_fields
final TopHitsAggregation.Builder	scriptFields(Map<String,ScriptField> map)	API name: script_fields
protected TopHitsAggregation.Builder	self()
final TopHitsAggregation.Builder	seqNoPrimaryTerm(Boolean value)	API name: seq_no_primary_term
final TopHitsAggregation.Builder	size(Integer value)	API name: size
final TopHitsAggregation.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
final TopHitsAggregation.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
final TopHitsAggregation.Builder	sort(List<SortOptions> list)	API name: sort
final TopHitsAggregation.Builder	source(SourceConfig value)	API name: _source
final TopHitsAggregation.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	API name: _source
final TopHitsAggregation.Builder	storedFields(String value, String... values)	API name: stored_fields
final TopHitsAggregation.Builder	storedFields(List<String> list)	API name: stored_fields
final TopHitsAggregation.Builder	trackScores(Boolean value)	API name: track_scores
final TopHitsAggregation.Builder	version(Boolean value)	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

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)

API name: docvalue_fields

Adds all elements of list to docvalueFields.

docvalueFields

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

API name: docvalue_fields

Adds one or more values to docvalueFields.

explain

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

API name: explain

from

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

API name: from

highlight

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

API name: highlight

highlight

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

API name: highlight

scriptFields

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

API name: script_fields

Adds all entries of map to scriptFields.

scriptFields

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

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

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

API name: size

sort

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

API name: sort

Adds all elements of list to sort.

sort

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

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

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

API name: _source

source

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

API name: _source

storedFields

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

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

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

API name: stored_fields

Adds one or more values to storedFields.

trackScores

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

API name: track_scores

version

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

API name: version

seqNoPrimaryTerm

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

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.