Class MutualInformationHeuristic.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<MutualInformationHeuristic.Builder>
co.elastic.clients.elasticsearch._types.aggregations.MutualInformationHeuristic.Builder
- All Implemented Interfaces:
WithJson<MutualInformationHeuristic.Builder>
,ObjectBuilder<MutualInformationHeuristic>
- Enclosing class:
- MutualInformationHeuristic
public static class MutualInformationHeuristic.Builder
extends WithJsonObjectBuilderBase<MutualInformationHeuristic.Builder>
implements ObjectBuilder<MutualInformationHeuristic>
Builder for
MutualInformationHeuristic
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbackgroundIsSuperset
(Boolean value) Set tofalse
if you defined a custom background filter that represents a different set of documents that you want to compare to.build()
Builds aMutualInformationHeuristic
.includeNegatives
(Boolean value) Set tofalse
to filter out the terms that appear less often in the subset than in documents outside the subset.protected MutualInformationHeuristic.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
backgroundIsSuperset
Set tofalse
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
Set tofalse
to filter out the terms that appear less often in the subset than in documents outside the subset.API name:
include_negatives
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<MutualInformationHeuristic.Builder>
-
build
Builds aMutualInformationHeuristic
.- Specified by:
build
in interfaceObjectBuilder<MutualInformationHeuristic>
- Throws:
NullPointerException
- if some of the required fields are null.
-