Package org.opensearch.client.opensearch.core.explain

Class Explanation

java.lang.Object

org.opensearch.client.opensearch.core.explain.Explanation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static Explanation.Builder	builder()
final String	description()	Required - API name: description
final List<Explanation>	details()	Required - API name: details
boolean	equals(Object o)
int	hashCode()
static Explanation	of(Function<Explanation.Builder,ObjectBuilder<Explanation>> 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	setupExplanationDeserializer(ObjectDeserializer<Explanation.Builder> op)
Explanation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Number	value()	Required - API name: value

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<Explanation> _DESERIALIZER

Json deserializer for Explanation

Method Details

of

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

description

@Nonnull
public final String description()

Required - API name: description

details

@Nonnull
public final List<Explanation> details()

Required - API name: details

value

@Nonnull
public final Number value()

Required - API name: value

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 Explanation.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<Explanation.Builder,Explanation>

Returns:

a new builder instance.

builder

@Nonnull
public static Explanation.Builder builder()

setupExplanationDeserializer

protected static void setupExplanationDeserializer(ObjectDeserializer<Explanation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object