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

Class CardinalityAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<CardinalityAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.CardinalityAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

CardinalityAggregation

public static class CardinalityAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<CardinalityAggregation.Builder>
implements CopyableBuilder<CardinalityAggregation.Builder,CardinalityAggregation>

Builder for CardinalityAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CardinalityAggregation	build()	Builds a CardinalityAggregation.
CardinalityAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CardinalityAggregation.Builder	executionHint(CardinalityExecutionMode value)	API name: execution_hint
final CardinalityAggregation.Builder	precisionThreshold(Integer value)	A unique count below which counts are expected to be close to accurate.
final CardinalityAggregation.Builder	rehash(Boolean value)	API name: rehash
protected CardinalityAggregation.Builder	self()

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

field, missing, missing, script, script

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

Returns:

a new builder instance.

self

@Nonnull
protected CardinalityAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<CardinalityAggregation.Builder>

executionHint

@Nonnull
public final CardinalityAggregation.Builder executionHint(@Nullable
 CardinalityExecutionMode value)

API name: execution_hint

precisionThreshold

@Nonnull
public final CardinalityAggregation.Builder precisionThreshold(@Nullable
 Integer value)

A unique count below which counts are expected to be close to accurate. This allows to trade memory for accuracy.

API name: precision_threshold

rehash

@Nonnull
public final CardinalityAggregation.Builder rehash(@Nullable
 Boolean value)

API name: rehash

build

@Nonnull
public CardinalityAggregation build()

Builds a CardinalityAggregation.

Specified by:

build in interface ObjectBuilder<CardinalityAggregation>

Throws:

NullPointerException - if some of the required fields are null.