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

Class RareTermsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

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

All Implemented Interfaces:

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

Enclosing class:

RareTermsAggregation

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

Builder for RareTermsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RareTermsAggregation	build()	Builds a RareTermsAggregation.
RareTermsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RareTermsAggregation.Builder	exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	API name: exclude
final RareTermsAggregation.Builder	exclude(TermsExclude value)	API name: exclude
final RareTermsAggregation.Builder	field(String value)	API name: field
final RareTermsAggregation.Builder	include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)	API name: include
final RareTermsAggregation.Builder	include(TermsInclude value)	API name: include
final RareTermsAggregation.Builder	maxDocCount(Long value)	The maximum number of documents a term should appear in.
final RareTermsAggregation.Builder	missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: missing
final RareTermsAggregation.Builder	missing(FieldValue value)	API name: missing
final RareTermsAggregation.Builder	precision(Double value)	The precision of the internal CuckooFilters.
protected RareTermsAggregation.Builder	self()
final RareTermsAggregation.Builder	valueType(String value)	API name: value_type

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 RareTermsAggregation.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<RareTermsAggregation.Builder,RareTermsAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected RareTermsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<RareTermsAggregation.Builder>

exclude

@Nonnull
public final RareTermsAggregation.Builder exclude(@Nullable
 TermsExclude value)

API name: exclude

exclude

@Nonnull
public final RareTermsAggregation.Builder exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)

API name: exclude

field

@Nonnull
public final RareTermsAggregation.Builder field(@Nullable
 String value)

API name: field

include

@Nonnull
public final RareTermsAggregation.Builder include(@Nullable
 TermsInclude value)

API name: include

include

@Nonnull
public final RareTermsAggregation.Builder include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)

API name: include

maxDocCount

@Nonnull
public final RareTermsAggregation.Builder maxDocCount(@Nullable
 Long value)

The maximum number of documents a term should appear in.

API name: max_doc_count

missing

@Nonnull
public final RareTermsAggregation.Builder missing(@Nullable
 FieldValue value)

API name: missing

missing

@Nonnull
public final RareTermsAggregation.Builder missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

API name: missing

precision

@Nonnull
public final RareTermsAggregation.Builder precision(@Nullable
 Double value)

The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage.

API name: precision

valueType

@Nonnull
public final RareTermsAggregation.Builder valueType(@Nullable
 String value)

API name: value_type

build

@Nonnull
public RareTermsAggregation build()

Builds a RareTermsAggregation.

Specified by:

build in interface ObjectBuilder<RareTermsAggregation>

Throws:

NullPointerException - if some of the required fields are null.