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

Class TopHitsAggregate

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregateBase

org.opensearch.client.opensearch._types.aggregations.TopHitsAggregate

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregateVariant

@JsonpDeserializable
public class TopHitsAggregate
extends AggregateBase
implements AggregateVariant

Nested Class Summary

Nested Classes

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

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

AggregateBase.AbstractBuilder<BuilderT extends AggregateBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregate.Kind	_aggregateKind()	Aggregate variant kind.
HitsMetadata<JsonData>	hits()	Required - API name: hits
static TopHitsAggregate	of(java.util.function.Function<TopHitsAggregate.Builder,ObjectBuilder<TopHitsAggregate>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTopHitsAggregateDeserializer(ObjectDeserializer<TopHitsAggregate.Builder> op)

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

meta, serialize, setupAggregateBaseDeserializer

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

_toAggregate

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

toJsonString

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<TopHitsAggregate> _DESERIALIZER

Json deserializer for TopHitsAggregate

Method Detail

of

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

_aggregateKind

public Aggregate.Kind _aggregateKind()

Aggregate variant kind.

Specified by:

_aggregateKind in interface AggregateVariant

hits

public final HitsMetadata<JsonData> hits()

Required - API name: hits

serializeInternal

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

Overrides:

serializeInternal in class AggregateBase

setupTopHitsAggregateDeserializer

protected static void setupTopHitsAggregateDeserializer(ObjectDeserializer<TopHitsAggregate.Builder> op)