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

Class BucketSortAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<BucketSortAggregation.Builder>

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

All Implemented Interfaces:

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.
BucketSortAggregation.Builder	from(java.lang.Integer value)	API name: from
BucketSortAggregation.Builder	gapPolicy(GapPolicy value)	API name: gap_policy
protected BucketSortAggregation.Builder	self()
BucketSortAggregation.Builder	size(java.lang.Integer value)	API name: size
BucketSortAggregation.Builder	sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
BucketSortAggregation.Builder	sort(java.util.List<SortOptions> list)	API name: sort
BucketSortAggregation.Builder	sort(SortOptions value, SortOptions... values)	API name: sort

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

from

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

API name: from

gapPolicy

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

API name: gap_policy

size

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

API name: size

sort

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

API name: sort

Adds all elements of list to sort.

sort

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

API name: sort

Adds one or more values to sort.

sort

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

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:

java.lang.NullPointerException - if some of the required fields are null.