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

Class RareTermsAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<RareTermsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.RareTermsAggregation.Builder

All Implemented Interfaces:

ObjectBuilder<RareTermsAggregation>

Enclosing class:

RareTermsAggregation

public static class RareTermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<RareTermsAggregation.Builder>
implements ObjectBuilder<RareTermsAggregation>

Builder for RareTermsAggregation.

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
RareTermsAggregation.Builder	addExclude(java.lang.String value)	Add a value to exclude(List), creating the list if needed.
RareTermsAggregation	build()	Builds a RareTermsAggregation.
RareTermsAggregation.Builder	exclude(java.lang.String... value)	API name: exclude
RareTermsAggregation.Builder	exclude(java.util.List<java.lang.String> value)	API name: exclude
RareTermsAggregation.Builder	field(java.lang.String value)	API name: field
RareTermsAggregation.Builder	include(jakarta.json.JsonValue value)	API name: include
RareTermsAggregation.Builder	maxDocCount(java.lang.Number value)	API name: max_doc_count
RareTermsAggregation.Builder	missing(jakarta.json.JsonValue value)	API name: missing
RareTermsAggregation.Builder	precision(java.lang.Number value)	API name: precision
protected RareTermsAggregation.Builder	self()
RareTermsAggregation.Builder	valueType(java.lang.String value)	API name: value_type

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

aggregations, aggregations, putAggregations, putAggregations

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

exclude

public RareTermsAggregation.Builder exclude(@Nullable java.util.List<java.lang.String> value)

API name: exclude

exclude

public RareTermsAggregation.Builder exclude(java.lang.String... value)

API name: exclude

addExclude

public RareTermsAggregation.Builder addExclude(java.lang.String value)

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

field

public RareTermsAggregation.Builder field(@Nullable java.lang.String value)

API name: field

include

public RareTermsAggregation.Builder include(@Nullable jakarta.json.JsonValue value)

API name: include

maxDocCount

public RareTermsAggregation.Builder maxDocCount(@Nullable java.lang.Number value)

API name: max_doc_count

missing

public RareTermsAggregation.Builder missing(@Nullable jakarta.json.JsonValue value)

API name: missing

precision

public RareTermsAggregation.Builder precision(@Nullable java.lang.Number value)

API name: precision

valueType

public RareTermsAggregation.Builder valueType(@Nullable java.lang.String value)

API name: value_type

self

protected RareTermsAggregation.Builder self()

Specified by:

self in class Aggregation.AbstractBuilder<RareTermsAggregation.Builder>

build

public RareTermsAggregation build()

Builds a RareTermsAggregation.

Specified by:

build in interface ObjectBuilder<RareTermsAggregation>

Throws:

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