Package org.elasticsearch.snapshots
Class SnapshotShardFailure
- java.lang.Object
-
- org.elasticsearch.snapshots.SnapshotShardFailure
-
- All Implemented Interfaces:
ShardOperationFailedException
,Streamable
,ToXContent
public class SnapshotShardFailure extends java.lang.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 Description SnapshotShardFailure(java.lang.String nodeId, ShardId shardId, java.lang.String reason)
Constructs new snapshot shard failure object
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
static SnapshotShardFailure
fromXContent(XContentParser parser)
Deserializes snapshot failure information from JSONjava.lang.Throwable
getCause()
The cause of this failureint
hashCode()
java.lang.String
index()
Returns index where failure occurredjava.lang.String
nodeId()
Returns node id where failure occurredvoid
readFrom(StreamInput in)
Set this object's fields from a StreamInput.static SnapshotShardFailure
readSnapshotShardFailure(StreamInput in)
Reads shard failure information from stream inputjava.lang.String
reason()
Returns reason for the failureint
shardId()
Returns shard id where failure occurredRestStatus
status()
ReturnsRestStatus
corresponding to this failurejava.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
static void
toXContent(SnapshotShardFailure snapshotShardFailure, XContentBuilder builder, ToXContent.Params params)
Serializes snapshot failure information into JSONvoid
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, 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
-
-
-
-
Method Detail
-
index
public java.lang.String index()
Returns index where failure occurred- Specified by:
index
in interfaceShardOperationFailedException
- Returns:
- index
-
shardId
public int shardId()
Returns shard id where failure occurred- Specified by:
shardId
in interfaceShardOperationFailedException
- Returns:
- shard id
-
reason
public java.lang.String reason()
Returns reason for the failure- Specified by:
reason
in interfaceShardOperationFailedException
- Returns:
- reason for the failure
-
status
public RestStatus status()
ReturnsRestStatus
corresponding to this failure- Specified by:
status
in interfaceShardOperationFailedException
- Returns:
- REST status
-
getCause
public java.lang.Throwable getCause()
Description copied from interface:ShardOperationFailedException
The cause of this failure- Specified by:
getCause
in interfaceShardOperationFailedException
-
nodeId
@Nullable public java.lang.String nodeId()
Returns node id where failure occurred- Returns:
- node id
-
readSnapshotShardFailure
public static SnapshotShardFailure readSnapshotShardFailure(StreamInput in) throws java.io.IOException
Reads shard failure information from stream input- Parameters:
in
- stream input- Returns:
- shard failure information
- 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
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toXContent
public static void toXContent(SnapshotShardFailure snapshotShardFailure, XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
Serializes snapshot failure information into JSON- Parameters:
snapshotShardFailure
- snapshot failure informationbuilder
- XContent builderparams
- additional parameters- Throws:
java.io.IOException
-
fromXContent
public static SnapshotShardFailure fromXContent(XContentParser parser) throws java.io.IOException
Deserializes snapshot failure information from JSON- Parameters:
parser
- JSON parser- Returns:
- snapshot failure information
- 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
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-