Package org.opensearch.client.opensearch._types.aggregations

Class TopHitsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<TopHitsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.TopHitsAggregation.Builder

All Implemented Interfaces:

CopyableBuilder<TopHitsAggregation.Builder,TopHitsAggregation>, MutableBuilder<TopHitsAggregation.Builder,TopHitsAggregation>, ObjectBuilder<TopHitsAggregation>

Enclosing class:

TopHitsAggregation

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

Builder for TopHitsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopHitsAggregation	build()	Builds a TopHitsAggregation.
TopHitsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
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)	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(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
final TopHitsAggregation.Builder	highlight(Highlight value)	API name: highlight
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(String key, ScriptField value)	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(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
final TopHitsAggregation.Builder	sort(List<SortOptions> list)	API name: sort
final TopHitsAggregation.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
final TopHitsAggregation.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	API name: _source
final TopHitsAggregation.Builder	source(SourceConfig value)	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)	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 org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder

field, missing, missing, script, script

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public TopHitsAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<TopHitsAggregation.Builder,TopHitsAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected TopHitsAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<TopHitsAggregation.Builder>

docvalueFields

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

API name: docvalue_fields

Adds all elements of list to docvalueFields.

docvalueFields

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

API name: docvalue_fields

Adds one or more values to docvalueFields.

explain

@Nonnull
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

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

Starting document offset.

API name: from

highlight

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

API name: highlight

highlight

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

API name: highlight

scriptFields

@Nonnull
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 elements of map to scriptFields.

scriptFields

@Nonnull
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

@Nonnull
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 a value to scriptFields using a builder lambda.

seqNoPrimaryTerm

@Nonnull
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

size

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

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

API name: size

sort

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

API name: sort

Adds all elements of list to sort.

sort

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

API name: sort

Adds one or more values to sort.

sort

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

API name: sort

Adds a value to sort using a builder lambda.

source

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

API name: _source

source

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

API name: _source

storedFields

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

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

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

API name: stored_fields

Adds one or more values to storedFields.

trackScores

@Nonnull
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

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

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

API name: version

build

@Nonnull
public TopHitsAggregation build()

Builds a TopHitsAggregation.

Specified by:

build in interface ObjectBuilder<TopHitsAggregation>

Throws:

NullPointerException - if some of the required fields are null.