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

Class TopHitsAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

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

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<TopHitsAggregation.Builder,TopHitsAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TopHitsAggregation
extends MetricAggregationBase
implements AggregationVariant, ToCopyableBuilder<TopHitsAggregation.Builder,TopHitsAggregation>

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 final JsonpDeserializer<TopHitsAggregation>	_DESERIALIZER	Json deserializer for TopHitsAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static TopHitsAggregation.Builder	builder()
final List<String>	docvalueFields()	API name: docvalue_fields
boolean	equals(Object o)
final Boolean	explain()	If true, returns detailed information about score computation as part of a hit.
final Integer	from()	Starting document offset.
int	hashCode()
final Highlight	highlight()	API name: highlight
static TopHitsAggregation	of(Function<TopHitsAggregation.Builder,ObjectBuilder<TopHitsAggregation>> fn)
final Map<String,ScriptField>	scriptFields()	Returns the result of one or more script evaluations for each hit.
final Boolean	seqNoPrimaryTerm()	If true, returns sequence number and primary term of the last modification of each hit.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTopHitsAggregationDeserializer(ObjectDeserializer<TopHitsAggregation.Builder> op)
final Integer	size()	The maximum number of top matching hits to return per bucket.
final List<SortOptions>	sort()	API name: sort
final SourceConfig	source()	API name: _source
final List<String>	storedFields()	API name: stored_fields
TopHitsAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	trackScores()	If true, calculates and returns document scores, even if the scores are not used for sorting.
final Boolean	version()	If true, returns document version as part of a hit.

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

field, missing, script, setupMetricAggregationBaseDeserializer

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

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

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

@Nonnull
public final List<String> docvalueFields()

API name: docvalue_fields

explain

@Nullable
public final Boolean explain()

If true, returns detailed information about score computation as part of a hit.

API name: explain

from

@Nullable
public final Integer from()

Starting document offset.

API name: from

highlight

@Nullable
public final Highlight highlight()

API name: highlight

scriptFields

@Nonnull
public final Map<String,ScriptField> scriptFields()

Returns the result of one or more script evaluations for each hit.

API name: script_fields

seqNoPrimaryTerm

@Nullable
public final Boolean seqNoPrimaryTerm()

If true, returns sequence number and primary term of the last modification of each hit.

API name: seq_no_primary_term

size

@Nullable
public final Integer size()

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

API name: size

sort

@Nonnull
public final List<SortOptions> sort()

API name: sort

source

@Nullable
public final SourceConfig source()

API name: _source

storedFields

@Nonnull
public final List<String> storedFields()

API name: stored_fields

trackScores

@Nullable
public final Boolean trackScores()

If true, calculates and returns document scores, even if the scores are not used for sorting.

API name: track_scores

version

@Nullable
public final Boolean version()

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

API name: version

serializeInternal

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

Overrides:

serializeInternal in class MetricAggregationBase

toBuilder

@Nonnull
public TopHitsAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TopHitsAggregation.Builder,TopHitsAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static TopHitsAggregation.Builder builder()

setupTopHitsAggregationDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class MetricAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class MetricAggregationBase