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

Class TopHitsAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

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

All Implemented Interfaces:

JsonpSerializable, AggregationVariant

@JsonpDeserializable
public class TopHitsAggregation
extends MetricAggregationBase
implements AggregationVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TopHitsAggregation.Builder	Builder for TopHitsAggregation.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

MetricAggregationBase.AbstractBuilder<BuilderT extends MetricAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<TopHitsAggregation>	_DESERIALIZER	Json deserializer for TopHitsAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
java.util.List<java.lang.String>	docvalueFields()	API name: docvalue_fields
java.lang.Boolean	explain()	API name: explain
java.lang.Integer	from()	API name: from
Highlight	highlight()	API name: highlight
static TopHitsAggregation	of(java.util.function.Function<TopHitsAggregation.Builder,ObjectBuilder<TopHitsAggregation>> fn)
java.util.Map<java.lang.String,ScriptField>	scriptFields()	API name: script_fields
java.lang.Boolean	seqNoPrimaryTerm()	API name: seq_no_primary_term
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTopHitsAggregationDeserializer(ObjectDeserializer<TopHitsAggregation.Builder> op)
java.lang.Integer	size()	API name: size
java.util.List<SortOptions>	sort()	API name: sort
SourceConfig	source()	API name: _source
java.util.List<java.lang.String>	storedFields()	API name: stored_fields
java.lang.Boolean	trackScores()	API name: track_scores
java.lang.Boolean	version()	API name: version

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

field, missing, script, serialize, setupMetricAggregationBaseDeserializer

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.opensearch._types.aggregations.AggregationVariant

_toAggregation

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<TopHitsAggregation> _DESERIALIZER

Json deserializer for TopHitsAggregation

Method Detail

of

public static TopHitsAggregation of(java.util.function.Function<TopHitsAggregation.Builder,ObjectBuilder<TopHitsAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

docvalueFields

public final java.util.List<java.lang.String> docvalueFields()

API name: docvalue_fields

explain

@Nullable
public final java.lang.Boolean explain()

API name: explain

from

@Nullable
public final java.lang.Integer from()

API name: from

highlight

@Nullable
public final Highlight highlight()

API name: highlight

scriptFields

public final java.util.Map<java.lang.String,ScriptField> scriptFields()

API name: script_fields

size

@Nullable
public final java.lang.Integer size()

API name: size

sort

public final java.util.List<SortOptions> sort()

API name: sort

source

@Nullable
public final SourceConfig source()

API name: _source

storedFields

public final java.util.List<java.lang.String> storedFields()

API name: stored_fields

trackScores

@Nullable
public final java.lang.Boolean trackScores()

API name: track_scores

version

@Nullable
public final java.lang.Boolean version()

API name: version

seqNoPrimaryTerm

@Nullable
public final java.lang.Boolean seqNoPrimaryTerm()

API name: seq_no_primary_term

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class MetricAggregationBase

setupTopHitsAggregationDeserializer

protected static void setupTopHitsAggregationDeserializer(ObjectDeserializer<TopHitsAggregation.Builder> op)