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

Class MutualInformationHeuristic

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<MutualInformationHeuristic.Builder,MutualInformationHeuristic>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class MutualInformationHeuristic
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<MutualInformationHeuristic.Builder,MutualInformationHeuristic>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MutualInformationHeuristic.Builder	Builder for MutualInformationHeuristic.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MutualInformationHeuristic>	_DESERIALIZER	Json deserializer for MutualInformationHeuristic

Method Summary

Modifier and Type	Method	Description
final Boolean	backgroundIsSuperset()	Set to false if you defined a custom background filter that represents a different set of documents that you want to compare to.
static MutualInformationHeuristic.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	includeNegatives()	Set to false to filter out the terms that appear less often in the subset than in documents outside the subset.
static MutualInformationHeuristic	of(Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupMutualInformationHeuristicDeserializer(ObjectDeserializer<MutualInformationHeuristic.Builder> op)
MutualInformationHeuristic.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<MutualInformationHeuristic> _DESERIALIZER

Json deserializer for MutualInformationHeuristic

Method Details

of

public static MutualInformationHeuristic of(Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)

backgroundIsSuperset

@Nullable
public final Boolean backgroundIsSuperset()

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

@Nullable
public final Boolean includeNegatives()

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

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public MutualInformationHeuristic.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MutualInformationHeuristic.Builder,MutualInformationHeuristic>

Returns:

a new builder instance.

builder

@Nonnull
public static MutualInformationHeuristic.Builder builder()

setupMutualInformationHeuristicDeserializer

protected static void setupMutualInformationHeuristicDeserializer(ObjectDeserializer<MutualInformationHeuristic.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object