Package co.elastic.clients.elasticsearch._types.aggregations

Class BucketSortAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketSortAggregation

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class BucketSortAggregation
extends AggregationBase
implements AggregationVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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.
final Integer	from()	Buckets in positions prior to from will be truncated.
final GapPolicy	gapPolicy()	The policy to apply when gaps are found in the data.
static BucketSortAggregation	of(Function<BucketSortAggregation.Builder,ObjectBuilder<BucketSortAggregation>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
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()	The list of fields to sort on.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

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()

The policy to apply when gaps are found in the data.

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

public final List<SortOptions> sort()

The list of fields to sort on.

API name: sort

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toString

public String toString()

Overrides:

toString in class Object

setupBucketSortAggregationDeserializer

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