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, ToCopyableBuilder<TopHitsAggregate.Builder,TopHitsAggregate>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TopHitsAggregate
extends AggregateBase
implements AggregateVariant, ToCopyableBuilder<TopHitsAggregate.Builder,TopHitsAggregate>

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

Method Summary

Modifier and Type	Method	Description
Aggregate.Kind	_aggregateKind()	Aggregate variant kind.
static TopHitsAggregate.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final HitsMetadata<JsonData>	hits()	Required - API name: hits
static TopHitsAggregate	of(Function<TopHitsAggregate.Builder,ObjectBuilder<TopHitsAggregate>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTopHitsAggregateDeserializer(ObjectDeserializer<TopHitsAggregate.Builder> op)
TopHitsAggregate.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

meta, serialize, setupAggregateBaseDeserializer

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

toAggregate

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<TopHitsAggregate> _DESERIALIZER

Json deserializer for TopHitsAggregate

Method Details

of

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

_aggregateKind

public Aggregate.Kind _aggregateKind()

Aggregate variant kind.

Specified by:

_aggregateKind in interface AggregateVariant

hits

@Nonnull
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

toBuilder

@Nonnull
public TopHitsAggregate.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<TopHitsAggregate.Builder,TopHitsAggregate>

Returns:

a new builder instance.

builder

@Nonnull
public static TopHitsAggregate.Builder builder()

setupTopHitsAggregateDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class AggregateBase

equals

public boolean equals(Object o)

Overrides:

equals in class AggregateBase