org.elasticsearch.snapshots

Class SnapshotShardFailure

java.lang.Object

org.elasticsearch.snapshots.SnapshotShardFailure

All Implemented Interfaces:

ShardOperationFailedException, Streamable, ToXContent

public class SnapshotShardFailure
extends Object
implements ShardOperationFailedException

Stores information about failures that occurred during shard snapshotting process

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
SnapshotShardFailure(String nodeId, String index, int shardId, String reason) Constructs new snapshot shard failure object

Method Summary

Methods

Modifier and Type	Method and Description
static SnapshotShardFailure	fromXContent(XContentParser parser) Deserializes snapshot failure information from JSON
Throwable	getCause() The cause of this failure.
String	index() Returns index where failure occurred
String	nodeId() Returns node id where failure occurred
void	readFrom(StreamInput in)
static SnapshotShardFailure	readSnapshotShardFailure(StreamInput in) Reads shard failure information from stream input
String	reason() Returns reason for the failure
int	shardId() Returns shard id where failure occurred
RestStatus	status() Returns REST status corresponding to this failure
String	toString()
static void	toXContent(SnapshotShardFailure snapshotShardFailure, XContentBuilder builder, ToXContent.Params params) Serializes snapshot failure information into JSON
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

Constructor Detail

SnapshotShardFailure

public SnapshotShardFailure(@Nullable
                    String nodeId,
                    String index,
                    int shardId,
                    String reason)

Constructs new snapshot shard failure object

Parameters:

nodeId - node where failure occurred

index - index which the shard belongs to

shardId - shard id

reason - failure reason

Method Detail

index

public String index()

Returns index where failure occurred

Specified by:

index in interface ShardOperationFailedException

Returns:

index

shardId

public int shardId()

Returns shard id where failure occurred

Specified by:

shardId in interface ShardOperationFailedException

Returns:

shard id

reason

public String reason()

Returns reason for the failure

Specified by:

reason in interface ShardOperationFailedException

Returns:

reason for the failure

status

public RestStatus status()

Returns REST status corresponding to this failure

Specified by:

status in interface ShardOperationFailedException

Returns:

REST status

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

nodeId

@Nullable
public String nodeId()

Returns node id where failure occurred

Returns:

node id

readSnapshotShardFailure

public static SnapshotShardFailure readSnapshotShardFailure(StreamInput in)
                                                     throws IOException

Reads shard failure information from stream input

Parameters:

in - stream input

Returns:

shard failure information

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

toString

public String toString()

Overrides:

toString in class Object

toXContent

public static void toXContent(SnapshotShardFailure snapshotShardFailure,
              XContentBuilder builder,
              ToXContent.Params params)
                       throws IOException

Serializes snapshot failure information into JSON

Parameters:

snapshotShardFailure - snapshot failure information

builder - XContent builder

params - additional parameters

Throws:

IOException

fromXContent

public static SnapshotShardFailure fromXContent(XContentParser parser)
                                         throws IOException

Deserializes snapshot failure information from JSON

Parameters:

parser - JSON parser

Returns:

snapshot failure information

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException