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

Class TopHitsAggregation.Builder

java.lang.Object

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

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

All Implemented Interfaces:

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.Builder	addDocvalueFields(java.lang.String value)	Add a value to docvalueFields(List), creating the list if needed.
TopHitsAggregation.Builder	addSort(jakarta.json.JsonValue value)	Add a value to sort(List), creating the list if needed.
TopHitsAggregation.Builder	addStoredFields(java.lang.String value)	Add a value to storedFields(List), creating the list if needed.
TopHitsAggregation	build()	Builds a TopHitsAggregation.
TopHitsAggregation.Builder	docvalueFields(java.lang.String... value)	API name: docvalue_fields
TopHitsAggregation.Builder	docvalueFields(java.util.List<java.lang.String> value)	API name: docvalue_fields
TopHitsAggregation.Builder	explain(java.lang.Boolean value)	API name: explain
TopHitsAggregation.Builder	from(java.lang.Integer value)	API name: from
TopHitsAggregation.Builder	highlight(Highlight value)	API name: highlight
TopHitsAggregation.Builder	highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
TopHitsAggregation.Builder	putScriptFields(java.lang.String key, ScriptField value)	Add a key/value to scriptFields(Map), creating the map if needed.
TopHitsAggregation.Builder	putScriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	Add a key/value to scriptFields(Map), creating the map if needed.
TopHitsAggregation.Builder	scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	Set scriptFields(Map) to a singleton map.
TopHitsAggregation.Builder	scriptFields(java.util.Map<java.lang.String,ScriptField> value)	API name: script_fields
protected TopHitsAggregation.Builder	self()
TopHitsAggregation.Builder	seqNoPrimaryTerm(java.lang.Boolean value)	API name: seq_no_primary_term
TopHitsAggregation.Builder	size(java.lang.Integer value)	API name: size
TopHitsAggregation.Builder	sort(jakarta.json.JsonValue... value)	API name: sort
TopHitsAggregation.Builder	sort(java.util.List<jakarta.json.JsonValue> value)	API name: sort
TopHitsAggregation.Builder	source(jakarta.json.JsonValue value)	API name: _source
TopHitsAggregation.Builder	storedFields(java.lang.String... value)	API name: stored_fields
TopHitsAggregation.Builder	storedFields(java.util.List<java.lang.String> value)	API name: stored_fields
TopHitsAggregation.Builder	trackScores(java.lang.Boolean value)	API name: track_scores
TopHitsAggregation.Builder	version(java.lang.Boolean value)	API name: version

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

field, missing, script

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

docvalueFields

public TopHitsAggregation.Builder docvalueFields(@Nullable
java.util.List<java.lang.String> value)

API name: docvalue_fields

docvalueFields

public TopHitsAggregation.Builder docvalueFields(java.lang.String... value)

API name: docvalue_fields

addDocvalueFields

public TopHitsAggregation.Builder addDocvalueFields(java.lang.String value)

Add a value to docvalueFields(List), creating the list if needed.

explain

public TopHitsAggregation.Builder explain(@Nullable
java.lang.Boolean value)

API name: explain

from

public TopHitsAggregation.Builder from(@Nullable
java.lang.Integer value)

API name: from

highlight

public TopHitsAggregation.Builder highlight(@Nullable
Highlight value)

API name: highlight

highlight

public TopHitsAggregation.Builder highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)

API name: highlight

scriptFields

public TopHitsAggregation.Builder scriptFields(@Nullable
java.util.Map<java.lang.String,ScriptField> value)

API name: script_fields

putScriptFields

public TopHitsAggregation.Builder putScriptFields(java.lang.String key,
ScriptField value)

Add a key/value to scriptFields(Map), creating the map if needed.

scriptFields

public TopHitsAggregation.Builder scriptFields(java.lang.String key,
java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

Set scriptFields(Map) to a singleton map.

putScriptFields

public TopHitsAggregation.Builder putScriptFields(java.lang.String key,
java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

Add a key/value to scriptFields(Map), creating the map if needed.

size

public TopHitsAggregation.Builder size(@Nullable
java.lang.Integer value)

API name: size

sort

public TopHitsAggregation.Builder sort(@Nullable
java.util.List<jakarta.json.JsonValue> value)

API name: sort

sort

public TopHitsAggregation.Builder sort(jakarta.json.JsonValue... value)

API name: sort

addSort

public TopHitsAggregation.Builder addSort(jakarta.json.JsonValue value)

Add a value to sort(List), creating the list if needed.

source

public TopHitsAggregation.Builder source(@Nullable
jakarta.json.JsonValue value)

API name: _source

storedFields

public TopHitsAggregation.Builder storedFields(@Nullable
java.util.List<java.lang.String> value)

API name: stored_fields

storedFields

public TopHitsAggregation.Builder storedFields(java.lang.String... value)

API name: stored_fields

addStoredFields

public TopHitsAggregation.Builder addStoredFields(java.lang.String value)

Add a value to storedFields(List), creating the list if needed.

trackScores

public TopHitsAggregation.Builder trackScores(@Nullable
java.lang.Boolean value)

API name: track_scores

version

public TopHitsAggregation.Builder version(@Nullable
java.lang.Boolean value)

API name: version

seqNoPrimaryTerm

public TopHitsAggregation.Builder seqNoPrimaryTerm(@Nullable
java.lang.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:

java.lang.NullPointerException - if some of the required fields are null.