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

Class BucketSortAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BucketSortAggregation.Builder>

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

All Implemented Interfaces:

WithJson<BucketSortAggregation.Builder>, ObjectBuilder<BucketSortAggregation>

Enclosing class:

BucketSortAggregation

public static class BucketSortAggregation.Builder
extends AggregationBase.AbstractBuilder<BucketSortAggregation.Builder>
implements ObjectBuilder<BucketSortAggregation>

Builder for BucketSortAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketSortAggregation	build()	Builds a BucketSortAggregation.
final BucketSortAggregation.Builder	from(Integer value)	Buckets in positions prior to from will be truncated.
final BucketSortAggregation.Builder	gapPolicy(GapPolicy value)	The policy to apply when gaps are found in the data.
protected BucketSortAggregation.Builder	self()
final BucketSortAggregation.Builder	size(Integer value)	The number of buckets to return.
final BucketSortAggregation.Builder	sort(SortOptions value, SortOptions... values)	The list of fields to sort on.
final BucketSortAggregation.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	The list of fields to sort on.
final BucketSortAggregation.Builder	sort(List<SortOptions> list)	The list of fields to sort on.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

from

public final BucketSortAggregation.Builder from(@Nullable
 Integer value)

Buckets in positions prior to from will be truncated.

API name: from

gapPolicy

public final BucketSortAggregation.Builder gapPolicy(@Nullable
 GapPolicy value)

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

API name: gap_policy

size

public final BucketSortAggregation.Builder size(@Nullable
 Integer value)

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

API name: size

sort

public final BucketSortAggregation.Builder sort(List<SortOptions> list)

The list of fields to sort on.

API name: sort

Adds all elements of list to sort.

sort

public final BucketSortAggregation.Builder sort(SortOptions value,
 SortOptions... values)

The list of fields to sort on.

API name: sort

Adds one or more values to sort.

sort

public final BucketSortAggregation.Builder sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

The list of fields to sort on.

API name: sort

Adds a value to sort using a builder lambda.

self

protected BucketSortAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<BucketSortAggregation.Builder>

build

public BucketSortAggregation build()

Builds a BucketSortAggregation.

Specified by:

build in interface ObjectBuilder<BucketSortAggregation>

Throws:

NullPointerException - if some of the required fields are null.