Package co.elastic.clients.elasticsearch._types.aggregations

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

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.
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.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

backgroundIsSuperset

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

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

self

protected MutualInformationHeuristic.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<MutualInformationHeuristic.Builder>

build

public MutualInformationHeuristic build()

Builds a MutualInformationHeuristic.

Specified by:

build in interface ObjectBuilder<MutualInformationHeuristic>

Throws:

NullPointerException - if some of the required fields are null.