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

Class MutualInformationHeuristic.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MutualInformationHeuristic.Builder

All Implemented Interfaces:

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

Enclosing class:

MutualInformationHeuristic

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

Builder for MutualInformationHeuristic.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MutualInformationHeuristic.Builder	backgroundIsSuperset(Boolean value)	Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to.
MutualInformationHeuristic	build()	Builds a MutualInformationHeuristic.
MutualInformationHeuristic.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MutualInformationHeuristic.Builder	includeNegatives(Boolean value)	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 MutualInformationHeuristic.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<MutualInformationHeuristic.Builder,MutualInformationHeuristic>

Returns:

a new builder instance.

backgroundIsSuperset

@Nonnull
public final MutualInformationHeuristic.Builder backgroundIsSuperset(@Nullable
 Boolean value)

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 MutualInformationHeuristic.Builder includeNegatives(@Nullable
 Boolean value)

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 MutualInformationHeuristic build()

Builds a MutualInformationHeuristic.

Specified by:

build in interface ObjectBuilder<MutualInformationHeuristic>

Throws:

NullPointerException - if some of the required fields are null.