Class QueryExplanation
- java.lang.Object
-
- org.elasticsearch.action.admin.indices.validate.query.QueryExplanation
-
- All Implemented Interfaces:
Streamable
,ToXContent
,ToXContentFragment
public class QueryExplanation extends java.lang.Object implements Streamable, ToXContentFragment
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
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.elasticsearch.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)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
static QueryExplanation
fromXContent(XContentParser parser)
java.lang.String
getError()
java.lang.String
getExplanation()
java.lang.String
getIndex()
int
getShard()
int
hashCode()
boolean
isValid()
void
readFrom(StreamInput in)
Set this object's fields from a StreamInput.static QueryExplanation
readQueryExplanation(StreamInput in)
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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()
-
readFrom
public void readFrom(StreamInput in) throws java.io.IOException
Description copied from interface:Streamable
Set this object's fields from a StreamInput.- Specified by:
readFrom
in interfaceStreamable
- Throws:
java.io.IOException
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Streamable
Write this object's fields to a StreamOutput.- Specified by:
writeTo
in interfaceStreamable
- Throws:
java.io.IOException
-
readQueryExplanation
public static QueryExplanation readQueryExplanation(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
fromXContent
public static QueryExplanation fromXContent(XContentParser parser)
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-