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

Class ChiSquareHeuristic.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.ChiSquareHeuristic.Builder

All Implemented Interfaces:

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

Enclosing class:

ChiSquareHeuristic

public static class ChiSquareHeuristic.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ChiSquareHeuristic.Builder,ChiSquareHeuristic>

Builder for ChiSquareHeuristic.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ChiSquareHeuristic.Builder	backgroundIsSuperset(boolean value)	Required - Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to.
ChiSquareHeuristic	build()	Builds a ChiSquareHeuristic.
ChiSquareHeuristic.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ChiSquareHeuristic.Builder	includeNegatives(boolean value)	Required - Set to false to filter out the terms that appear less often in the subset than in documents outside the subset.

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

Returns:

a new builder instance.

backgroundIsSuperset

@Nonnull
public final ChiSquareHeuristic.Builder backgroundIsSuperset(boolean value)

Required - Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to.

API name: background_is_superset

includeNegatives

@Nonnull
public final ChiSquareHeuristic.Builder includeNegatives(boolean value)

Required - Set to false to filter out the terms that appear less often in the subset than in documents outside the subset.

API name: include_negatives

build

@Nonnull
public ChiSquareHeuristic build()

Builds a ChiSquareHeuristic.

Specified by:

build in interface ObjectBuilder<ChiSquareHeuristic>

Throws:

NullPointerException - if some of the required fields are null.