Package org.elasticsearch.action.search
Class ShardSearchFailure
- java.lang.Object
-
- org.elasticsearch.action.search.ShardSearchFailure
-
- All Implemented Interfaces:
ShardOperationFailedException
,Streamable
,ToXContent
public class ShardSearchFailure extends java.lang.Object implements ShardOperationFailedException
Represents a failure to search on a specific shard.
-
-
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 ShardSearchFailure[]
EMPTY_ARRAY
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description ShardSearchFailure(java.lang.Exception e)
ShardSearchFailure(java.lang.Exception e, SearchShardTarget shardTarget)
ShardSearchFailure(java.lang.String reason, SearchShardTarget shardTarget)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ShardSearchFailure
fromXContent(XContentParser parser)
java.lang.Throwable
getCause()
The cause of this failurejava.lang.String
index()
The index the search failed on.void
readFrom(StreamInput in)
Set this object's fields from a StreamInput.static ShardSearchFailure
readShardSearchFailure(StreamInput in)
java.lang.String
reason()
The reason of the failure.SearchShardTarget
shard()
The search shard target the failure occurred on.int
shardId()
The shard id the search failed on.RestStatus
status()
The status of the failure.java.lang.String
toString()
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.io.stream.Streamable
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent
isFragment
-
-
-
-
Field Detail
-
EMPTY_ARRAY
public static final ShardSearchFailure[] EMPTY_ARRAY
-
-
Constructor Detail
-
ShardSearchFailure
public ShardSearchFailure(java.lang.Exception e)
-
ShardSearchFailure
public ShardSearchFailure(java.lang.Exception e, @Nullable SearchShardTarget shardTarget)
-
ShardSearchFailure
public ShardSearchFailure(java.lang.String reason, SearchShardTarget shardTarget)
-
-
Method Detail
-
shard
@Nullable public SearchShardTarget shard()
The search shard target the failure occurred on.
-
status
public RestStatus status()
Description copied from interface:ShardOperationFailedException
The status of the failure.- Specified by:
status
in interfaceShardOperationFailedException
-
index
public java.lang.String index()
The index the search failed on.- Specified by:
index
in interfaceShardOperationFailedException
-
shardId
public int shardId()
The shard id the search failed on.- Specified by:
shardId
in interfaceShardOperationFailedException
-
reason
public java.lang.String reason()
The reason of the failure.- Specified by:
reason
in interfaceShardOperationFailedException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
readShardSearchFailure
public static ShardSearchFailure readShardSearchFailure(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
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
-
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 ShardSearchFailure fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
getCause
public java.lang.Throwable getCause()
Description copied from interface:ShardOperationFailedException
The cause of this failure- Specified by:
getCause
in interfaceShardOperationFailedException
-
-