org.elasticsearch.action.admin.indices.status
Class ShardStatus

java.lang.Object
  extended by org.elasticsearch.action.support.broadcast.BroadcastShardOperationResponse
      extended by org.elasticsearch.action.admin.indices.status.ShardStatus
All Implemented Interfaces:
Streamable

public class ShardStatus
extends BroadcastShardOperationResponse

Shard instance (actual allocated shard) status.


Method Summary
 DocsStatus docs()
          Docs level information for the shard index, null if not applicable.
 GatewayRecoveryStatus gatewayRecoveryStatus()
          Gateway recovery status (null if not applicable).
 GatewaySnapshotStatus gatewaySnapshotStatus()
          The current on going snapshot to the gateway or the last one if none is on going.
 DocsStatus getDocs()
          Docs level information for the shard index, null if not applicable.
 GatewayRecoveryStatus getGatewayRecoveryStatus()
          Gateway recovery status (null if not applicable).
 GatewaySnapshotStatus getGatewaySnapshotStatus()
          The current on going snapshot to the gateway or the last one if none is on going.
 PeerRecoveryStatus getPeerRecoveryStatus()
          Peer recovery status (null if not applicable).
 ShardRouting getShardRouting()
          The shard routing information (cluster wide shard state).
 IndexShardState getState()
          The shard state (index/local state).
 ByteSizeValue getStoreSize()
          The current size of the shard index storage.
 long getTranslogId()
          The transaction log id.
 long getTranslogOperations()
          The number of transaction operations in the transaction log.
 PeerRecoveryStatus peerRecoveryStatus()
          Peer recovery status (null if not applicable).
 void readFrom(StreamInput in)
           
static ShardStatus readIndexShardStatus(StreamInput in)
           
 ShardRouting shardRouting()
          The shard routing information (cluster wide shard state).
 IndexShardState state()
          The shard state (index/local state).
 ByteSizeValue storeSize()
          The current size of the shard index storage.
 long translogId()
          The transaction log id.
 long translogOperations()
          The number of transaction operations in the transaction log.
 void writeTo(StreamOutput out)
           
 
Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastShardOperationResponse
getIndex, getShardId, index, shardId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

shardRouting

public ShardRouting shardRouting()
The shard routing information (cluster wide shard state).


getShardRouting

public ShardRouting getShardRouting()
The shard routing information (cluster wide shard state).


state

public IndexShardState state()
The shard state (index/local state).


getState

public IndexShardState getState()
The shard state (index/local state).


storeSize

public ByteSizeValue storeSize()
The current size of the shard index storage.


getStoreSize

public ByteSizeValue getStoreSize()
The current size of the shard index storage.


translogId

public long translogId()
The transaction log id.


getTranslogId

public long getTranslogId()
The transaction log id.


translogOperations

public long translogOperations()
The number of transaction operations in the transaction log.


getTranslogOperations

public long getTranslogOperations()
The number of transaction operations in the transaction log.


docs

public DocsStatus docs()
Docs level information for the shard index, null if not applicable.


getDocs

public DocsStatus getDocs()
Docs level information for the shard index, null if not applicable.


peerRecoveryStatus

public PeerRecoveryStatus peerRecoveryStatus()
Peer recovery status (null if not applicable). Both real time if an on going recovery is in progress and summary once it is done.


getPeerRecoveryStatus

public PeerRecoveryStatus getPeerRecoveryStatus()
Peer recovery status (null if not applicable). Both real time if an on going recovery is in progress and summary once it done.


gatewayRecoveryStatus

public GatewayRecoveryStatus gatewayRecoveryStatus()
Gateway recovery status (null if not applicable). Both real time if an on going recovery is in progress adn summary once it is done.


getGatewayRecoveryStatus

public GatewayRecoveryStatus getGatewayRecoveryStatus()
Gateway recovery status (null if not applicable). Both real time if an on going recovery is in progress adn summary once it is done.


gatewaySnapshotStatus

public GatewaySnapshotStatus gatewaySnapshotStatus()
The current on going snapshot to the gateway or the last one if none is on going.


getGatewaySnapshotStatus

public GatewaySnapshotStatus getGatewaySnapshotStatus()
The current on going snapshot to the gateway or the last one if none is on going.


readIndexShardStatus

public static ShardStatus readIndexShardStatus(StreamInput in)
                                        throws java.io.IOException
Throws:
java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException
Specified by:
writeTo in interface Streamable
Overrides:
writeTo in class BroadcastShardOperationResponse
Throws:
java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException
Specified by:
readFrom in interface Streamable
Overrides:
readFrom in class BroadcastShardOperationResponse
Throws:
java.io.IOException