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:

CopyableBuilder<BucketSortAggregation.Builder,BucketSortAggregation>, MutableBuilder<BucketSortAggregation.Builder,BucketSortAggregation>, ObjectBuilder<BucketSortAggregation>

Enclosing class:

BucketSortAggregation

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

Builder for BucketSortAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketSortAggregation	build()	Builds a BucketSortAggregation.
BucketSortAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final BucketSortAggregation.Builder	from(Integer value)	Buckets in positions prior to from will be truncated.
final BucketSortAggregation.Builder	gapPolicy(GapPolicy value)	API name: gap_policy
protected BucketSortAggregation.Builder	self()
final BucketSortAggregation.Builder	size(Integer value)	The number of buckets to return.
final BucketSortAggregation.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
final BucketSortAggregation.Builder	sort(List<SortOptions> list)	API name: sort
final 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, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public BucketSortAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<BucketSortAggregation.Builder,BucketSortAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected BucketSortAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<BucketSortAggregation.Builder>

from

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

Buckets in positions prior to from will be truncated.

API name: from

gapPolicy

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

API name: gap_policy

size

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

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

API name: sort

Adds all elements of list to sort.

sort

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

API name: sort

Adds one or more values to sort.

sort

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

API name: sort

Adds a value to sort using a builder lambda.

build

@Nonnull
public BucketSortAggregation build()

Builds a BucketSortAggregation.

Specified by:

build in interface ObjectBuilder<BucketSortAggregation>

Throws:

NullPointerException - if some of the required fields are null.