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:

ToJsonp

public final class TopHitsAggregation
extends MetricAggregationBase

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TopHitsAggregation(TopHitsAggregation.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	docvalueFields()	API name: docvalue_fields
java.lang.Boolean	explain()	API name: explain
java.lang.Number	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 static void	setupTopHitsAggregationDeserializer(DelegatingDeserializer<TopHitsAggregation.Builder> op)
java.lang.Number	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
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
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, setupMetricAggregationBaseDeserializer, toJsonp

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<TopHitsAggregation> DESERIALIZER

Json deserializer for TopHitsAggregation

Constructor Details

TopHitsAggregation

protected TopHitsAggregation(TopHitsAggregation.Builder builder)

Method Details

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.Number 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.Number 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

toJsonpInternal

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

Overrides:

toJsonpInternal in class MetricAggregationBase

setupTopHitsAggregationDeserializer

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