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

Class BucketSortAggregation

java.lang.Object

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

org.opensearch.client.opensearch._types.aggregations.BucketSortAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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

AggregationBase.AbstractBuilder<BuilderT extends AggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static BucketSortAggregation.Builder	builder()
boolean	equals(Object o)
final Integer	from()	Buckets in positions prior to from will be truncated.
final GapPolicy	gapPolicy()	API name: gap_policy
int	hashCode()
static BucketSortAggregation	of(Function<BucketSortAggregation.Builder,ObjectBuilder<BucketSortAggregation>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupBucketSortAggregationDeserializer(ObjectDeserializer<BucketSortAggregation.Builder> op)
final Integer	size()	The number of buckets to return.
final List<SortOptions>	sort()	API name: sort
BucketSortAggregation.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.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<BucketSortAggregation> _DESERIALIZER

Json deserializer for BucketSortAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

from

@Nullable
public final Integer from()

Buckets in positions prior to from will be truncated.

API name: from

gapPolicy

@Nullable
public final GapPolicy gapPolicy()

API name: gap_policy

size

@Nullable
public final Integer size()

The number of buckets to return. Defaults to all buckets of the parent aggregation.

API name: size

sort

@Nonnull
public final List<SortOptions> sort()

API name: sort

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static BucketSortAggregation.Builder builder()

setupBucketSortAggregationDeserializer

protected static void setupBucketSortAggregationDeserializer(ObjectDeserializer<BucketSortAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class AggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class AggregationBase