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

Class BucketSortAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.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 Aggregation.AbstractBuilder<BucketSortAggregation.Builder>
implements ObjectBuilder<BucketSortAggregation>

Builder for BucketSortAggregation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketSortAggregation.Builder	addSort(jakarta.json.JsonValue value)	Add a value to sort(List), creating the list if needed.
BucketSortAggregation	build()	Builds a BucketSortAggregation.
BucketSortAggregation.Builder	from(java.lang.Number value)	API name: from
BucketSortAggregation.Builder	gapPolicy(jakarta.json.JsonValue value)	API name: gap_policy
protected BucketSortAggregation.Builder	self()
BucketSortAggregation.Builder	size(java.lang.Number value)	API name: size
BucketSortAggregation.Builder	sort(jakarta.json.JsonValue... value)	API name: sort
BucketSortAggregation.Builder	sort(java.util.List<jakarta.json.JsonValue> value)	API name: sort

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

meta, name, putMeta

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

from

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

API name: from

gapPolicy

public BucketSortAggregation.Builder gapPolicy(@Nullable jakarta.json.JsonValue value)

API name: gap_policy

size

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

API name: size

sort

public BucketSortAggregation.Builder sort(@Nullable java.util.List<jakarta.json.JsonValue> value)

API name: sort

sort

public BucketSortAggregation.Builder sort(jakarta.json.JsonValue... value)

API name: sort

addSort

public BucketSortAggregation.Builder addSort(jakarta.json.JsonValue value)

Add a value to sort(List), creating the list if needed.

self

protected BucketSortAggregation.Builder self()

Specified by:

self in class Aggregation.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.