Package org.opensearch.client.opensearch.indices.validate_query

Class IndicesValidationExplanation

java.lang.Object

org.opensearch.client.opensearch.indices.validate_query.IndicesValidationExplanation

All Implemented Interfaces:

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

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

The validation results for an index query.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static IndicesValidationExplanation.Builder	builder()
boolean	equals(Object o)
final String	error()	The error message if validation failed.
final String	explanation()	The explanation of why the query is valid or invalid.
int	hashCode()
final String	index()	Required - API name: index
static IndicesValidationExplanation	of(Function<IndicesValidationExplanation.Builder,ObjectBuilder<IndicesValidationExplanation>> 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	setupIndicesValidationExplanationDeserializer(ObjectDeserializer<IndicesValidationExplanation.Builder> op)
IndicesValidationExplanation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final boolean	valid()	Required - Whether the query is valid for the index.

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

Json deserializer for IndicesValidationExplanation

Method Details

of

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

error

@Nullable
public final String error()

The error message if validation failed.

API name: error

explanation

@Nullable
public final String explanation()

The explanation of why the query is valid or invalid.

API name: explanation

index

@Nonnull
public final String index()

Required - API name: index

valid

public final boolean valid()

Required - Whether the query is valid for the index.

API name: valid

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

Returns:

a new builder instance.

builder

@Nonnull
public static IndicesValidationExplanation.Builder builder()

setupIndicesValidationExplanationDeserializer

protected static void setupIndicesValidationExplanationDeserializer(ObjectDeserializer<IndicesValidationExplanation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object