Package org.opensearch.action.admin.indices.validate.query

Class QueryExplanation

java.lang.Object

org.opensearch.action.admin.indices.validate.query.QueryExplanation

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class QueryExplanation
extends java.lang.Object
implements Writeable, org.opensearch.common.xcontent.ToXContentFragment

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_FIELD
static java.lang.String	EXPLANATION_FIELD
static java.lang.String	INDEX_FIELD
static int	RANDOM_SHARD
static java.lang.String	SHARD_FIELD
static java.lang.String	VALID_FIELD

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
QueryExplanation(java.lang.String index, int shard, boolean valid, java.lang.String explanation, java.lang.String error)
QueryExplanation(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static QueryExplanation	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
java.lang.String	getError()
java.lang.String	getExplanation()
java.lang.String	getIndex()
int	getShard()
int	hashCode()
boolean	isValid()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

INDEX_FIELD

public static final java.lang.String INDEX_FIELD

See Also:

Constant Field Values

SHARD_FIELD

public static final java.lang.String SHARD_FIELD

See Also:

Constant Field Values

VALID_FIELD

public static final java.lang.String VALID_FIELD

See Also:

Constant Field Values

ERROR_FIELD

public static final java.lang.String ERROR_FIELD

See Also:

Constant Field Values

EXPLANATION_FIELD

public static final java.lang.String EXPLANATION_FIELD

See Also:

Constant Field Values

RANDOM_SHARD

public static final int RANDOM_SHARD

See Also:

Constant Field Values

Constructor Details

QueryExplanation

public QueryExplanation(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

QueryExplanation

public QueryExplanation(java.lang.String index, int shard, boolean valid, java.lang.String explanation, java.lang.String error)

Method Details

getIndex

public java.lang.String getIndex()

getShard

public int getShard()

isValid

public boolean isValid()

getError

public java.lang.String getError()

getExplanation

public java.lang.String getExplanation()

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException

fromXContent

public static QueryExplanation fromXContent(org.opensearch.common.xcontent.XContentParser parser)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object