org.elasticsearch.action.admin.cluster.snapshots.status

Class SnapshotIndexShardStatus

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.support.broadcast.BroadcastShardResponse

org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotIndexShardStatus

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

public class SnapshotIndexShardStatus
extends BroadcastShardResponse
implements ToXContent

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Method Summary

Methods

Modifier and Type	Method and Description
String	getFailure() Returns reason for snapshot failure
String	getNodeId() Returns node id of the node where snapshot is currently running
SnapshotIndexShardStage	getStage() Returns snapshot stage
SnapshotStats	getStats() Returns snapshot stats
void	readFrom(StreamInput in)
static SnapshotIndexShardStatus	readShardSnapshotStatus(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastShardResponse

getIndex, getShardId

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Method Detail

getStage

public SnapshotIndexShardStage getStage()

Returns snapshot stage

getStats

public SnapshotStats getStats()

Returns snapshot stats

getNodeId

public String getNodeId()

Returns node id of the node where snapshot is currently running

getFailure

public String getFailure()

Returns reason for snapshot failure

readShardSnapshotStatus

public static SnapshotIndexShardStatus readShardSnapshotStatus(StreamInput in)
                                                        throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastShardResponse

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastShardResponse

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException