Package org.elasticsearch.action.support.replication

Class ReplicationResponse.ShardInfo.Failure

java.lang.Object

org.elasticsearch.action.support.replication.ReplicationResponse.ShardInfo.Failure

All Implemented Interfaces:

ShardOperationFailedException, Streamable, ToXContent, ToXContentObject

Enclosing class:

ReplicationResponse.ShardInfo

public static class ReplicationResponse.ShardInfo.Failure
extends java.lang.Object
implements ShardOperationFailedException, ToXContentObject

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	Description
Failure(ShardId shardId, java.lang.String nodeId, java.lang.Exception cause, RestStatus status, boolean primary)

Method Summary

Modifier and Type	Method	Description
static ReplicationResponse.ShardInfo.Failure	fromXContent(XContentParser parser)
ShardId	fullShardId()
java.lang.Throwable	getCause()	The cause of this failure
java.lang.String	index()	The index the operation failed on.
java.lang.String	nodeId()
boolean	primary()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.lang.String	reason()	The reason of the failure.
int	shardId()	The index the operation failed on.
RestStatus	status()	The status of the failure.
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, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

Failure

public Failure(ShardId shardId,
               @Nullable
               java.lang.String nodeId,
               java.lang.Exception cause,
               RestStatus status,
               boolean primary)

Method Detail

index

public java.lang.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 index 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.

fullShardId

public ShardId fullShardId()

nodeId

@Nullable
public java.lang.String nodeId()

Returns:

On what node the failure occurred.

reason

public java.lang.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 java.lang.Throwable getCause()

Description copied from interface: ShardOperationFailedException

The cause of this failure

Specified by:

getCause in interface ShardOperationFailedException

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 java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

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

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public static ReplicationResponse.ShardInfo.Failure fromXContent(XContentParser parser)
                                                          throws java.io.IOException

Throws:

java.io.IOException