org.elasticsearch.action.search

Class ShardSearchFailure

java.lang.Object

org.elasticsearch.action.search.ShardSearchFailure

All Implemented Interfaces:

ShardOperationFailedException, Streamable, ToXContent

public class ShardSearchFailure
extends 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 and Description
static ShardSearchFailure[]	EMPTY_ARRAY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ShardSearchFailure(String reason, SearchShardTarget shardTarget)
ShardSearchFailure(String reason, SearchShardTarget shardTarget, RestStatus status)
ShardSearchFailure(Throwable t)
ShardSearchFailure(Throwable t, SearchShardTarget shardTarget)

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	getCause() The cause of this failure.
String	index() The index the search failed on.
void	readFrom(StreamInput in)
static ShardSearchFailure	readShardSearchFailure(StreamInput in)
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.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final ShardSearchFailure[] EMPTY_ARRAY

Constructor Detail

ShardSearchFailure

public ShardSearchFailure(Throwable t)

ShardSearchFailure

public ShardSearchFailure(Throwable t,
                  @Nullable
                  SearchShardTarget shardTarget)

ShardSearchFailure

public ShardSearchFailure(String reason,
                  SearchShardTarget shardTarget)

ShardSearchFailure

public ShardSearchFailure(String reason,
                  SearchShardTarget shardTarget,
                  RestStatus status)

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 interface ShardOperationFailedException

Returns:

The status of the failure

index

public String index()

The index the search failed on.

Specified by:

index in interface ShardOperationFailedException

Returns:

The index the operation failed on or null if it can't be derived

shardId

public int shardId()

The shard id the search failed on.

Specified by:

shardId in interface ShardOperationFailedException

Returns:

The shard the operation failed on or -1 if it can't be derived

reason

public String reason()

The reason of the failure.

Specified by:

reason in interface ShardOperationFailedException

Returns:

The reason of the failure

toString

public String toString()

Overrides:

toString in class Object

readShardSearchFailure

public static ShardSearchFailure readShardSearchFailure(StreamInput in)
                                                 throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getCause

public Throwable getCause()

Description copied from interface: ShardOperationFailedException

The cause of this failure.

Specified by:

getCause in interface ShardOperationFailedException

Returns:

The cause of this failure