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

Class TopHitsAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase

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

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class TopHitsAggregation
extends MetricAggregationBase
implements AggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final List<String>	docvalueFields()	API name: docvalue_fields
final Boolean	explain()	API name: explain
final Integer	from()	API name: from
final Highlight	highlight()	API name: highlight
static TopHitsAggregation	of(Function<TopHitsAggregation.Builder,ObjectBuilder<TopHitsAggregation>> fn)
final Map<String,ScriptField>	scriptFields()	API name: script_fields
final 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)
final Integer	size()	API name: size
final List<SortOptions>	sort()	API name: sort
final SourceConfig	source()	API name: _source
final List<String>	storedFields()	API name: stored_fields
final Boolean	trackScores()	API name: track_scores
final Boolean	version()	API name: version

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

field, missing, script, serialize, setupMetricAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TopHitsAggregation> _DESERIALIZER

Json deserializer for TopHitsAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

docvalueFields

public final List<String> docvalueFields()

API name: docvalue_fields

explain

@Nullable
public final Boolean explain()

API name: explain

from

@Nullable
public final Integer from()

API name: from

highlight

@Nullable
public final Highlight highlight()

API name: highlight

scriptFields

public final Map<String,ScriptField> scriptFields()

API name: script_fields

size

@Nullable
public final Integer size()

API name: size

sort

public final List<SortOptions> sort()

API name: sort

source

@Nullable
public final SourceConfig source()

API name: _source

storedFields

public final List<String> storedFields()

API name: stored_fields

trackScores

@Nullable
public final Boolean trackScores()

API name: track_scores

version

@Nullable
public final Boolean version()

API name: version

seqNoPrimaryTerm

@Nullable
public final 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)