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, UnionVariant

@JsonpDeserializable
public final 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 co.elastic.clients.elasticsearch._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

Constructor Summary

Constructors

Constructor	Description
TopHitsAggregation(TopHitsAggregation.Builder builder)
TopHitsAggregation(java.util.function.Function<TopHitsAggregation.Builder,TopHitsAggregation.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	_variantType()	Aggregation variant type
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
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(DelegatingDeserializer<TopHitsAggregation.Builder> op)
java.lang.Integer	size()	API name: size
java.util.List<jakarta.json.JsonValue>	sort()	API name: sort
jakarta.json.JsonValue	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 co.elastic.clients.elasticsearch._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 co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TopHitsAggregation> _DESERIALIZER

Json deserializer for TopHitsAggregation

Constructor Details

TopHitsAggregation

public TopHitsAggregation(TopHitsAggregation.Builder builder)

TopHitsAggregation

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

Method Details

_variantType

public java.lang.String _variantType()

Aggregation variant type

Specified by:

_variantType in interface UnionVariant

docvalueFields

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

API name: docvalue_fields

explain

@Nullable
public java.lang.Boolean explain()

API name: explain

from

@Nullable
public java.lang.Integer from()

API name: from

highlight

@Nullable
public Highlight highlight()

API name: highlight

scriptFields

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

API name: script_fields

size

@Nullable
public java.lang.Integer size()

API name: size

sort

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

API name: sort

source

@Nullable
public jakarta.json.JsonValue source()

API name: _source

storedFields

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

API name: stored_fields

trackScores

@Nullable
public java.lang.Boolean trackScores()

API name: track_scores

version

@Nullable
public java.lang.Boolean version()

API name: version

seqNoPrimaryTerm

@Nullable
public 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(DelegatingDeserializer<TopHitsAggregation.Builder> op)