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 -
Method Summary
Modifier and TypeMethodDescriptionbackgroundIsSuperset(Boolean value) Set tofalseif you defined a custom background filter that represents a different set of documents that you want to compare to.build()Builds aMutualInformationHeuristic.copy()Create a new builderCopyableBuilderthat is a copy of this one.includeNegatives(Boolean value) Set tofalseto 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, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<MutualInformationHeuristic.Builder,MutualInformationHeuristic> - Returns:
- a new builder instance.
-
backgroundIsSuperset
@Nonnull public final MutualInformationHeuristic.Builder backgroundIsSuperset(@Nullable Boolean value) Set tofalseif 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
Set tofalseto filter out the terms that appear less often in the subset than in documents outside the subset.API name:
include_negatives -
build
Builds aMutualInformationHeuristic.- Specified by:
buildin interfaceObjectBuilder<MutualInformationHeuristic>- Throws:
NullPointerException- if some of the required fields are null.
-