org.elasticsearch.action

Class ActionWriteResponse.ShardInfo.Failure

java.lang.Object

org.elasticsearch.action.ActionWriteResponse.ShardInfo.Failure

All Implemented Interfaces:

ShardOperationFailedException, Streamable, ToXContent

Enclosing class:

ActionWriteResponse.ShardInfo

public static class ActionWriteResponse.ShardInfo.Failure
extends Object
implements ShardOperationFailedException, ToXContent

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Failure(String index, int shardId, String nodeId, Throwable cause, RestStatus status, boolean primary)

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() The cause of this failure.
String	index() The index the operation failed on.
String	nodeId()
boolean	primary()
void	readFrom(StreamInput in)
String	reason() The reason of the failure.
int	shardId() The shard the operation failed on.
RestStatus	status() The status of the failure.
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, toString, wait, wait, wait

Constructor Detail

Failure

public Failure(String index,
               int shardId,
               @Nullable
               String nodeId,
               Throwable cause,
               RestStatus status,
               boolean primary)

Method Detail

index

public String index()

Description copied from interface: ShardOperationFailedException

The index the operation failed on. Might return null if it can't be derived.

Specified by:

index in interface ShardOperationFailedException

Returns:

On what index the failure occurred.

shardId

public int shardId()

Description copied from interface: ShardOperationFailedException

The shard the operation failed on. Might return -1 if it can't be derived.

Specified by:

shardId in interface ShardOperationFailedException

Returns:

On what shard id the failure occurred.

nodeId

@Nullable
public String nodeId()

Returns:

On what node the failure occurred.

reason

public String reason()

Description copied from interface: ShardOperationFailedException

The reason of the failure.

Specified by:

reason in interface ShardOperationFailedException

Returns:

A text description of the failure

status

public RestStatus status()

Description copied from interface: ShardOperationFailedException

The status of the failure.

Specified by:

status in interface ShardOperationFailedException

Returns:

The status to report if this failure was a primary failure.

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

primary

public boolean primary()

Returns:

Whether this failure occurred on a primary shard. (this only reports true for delete by query)

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