Class NodeAllocationResult.ShardStoreInfo

All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment
Enclosing class:

public static final class NodeAllocationResult.ShardStoreInfo extends Object implements ToXContentFragment, Writeable
A class that captures metadata about a shard store on a node.
  • Constructor Details

    • ShardStoreInfo

      public ShardStoreInfo(String allocationId, boolean inSync, Exception storeException)
    • ShardStoreInfo

      public ShardStoreInfo(long matchingBytes)
    • ShardStoreInfo

      public ShardStoreInfo(StreamInput in) throws IOException
  • Method Details

    • isInSync

      public boolean isInSync()
      Returns true if the shard copy is in-sync and contains the latest data. Returns false if the shard copy is stale or if the shard copy being examined is for a replica shard allocation.
    • getAllocationId

      @Nullable public String getAllocationId()
      Gets the allocation id for the shard copy, if it exists.
    • hasMatchingSyncId

      public boolean hasMatchingSyncId()
      Returns true if the shard copy has a matching sync id with the primary shard. Returns false if the shard copy does not have a matching sync id with the primary shard, or this explanation pertains to the allocation of a primary shard, in which case matching sync ids are irrelevant.
    • getMatchingBytes

      public long getMatchingBytes()
      Gets the number of matching bytes the shard copy has with the primary shard. Returns Long.MAX_VALUE if hasMatchingSyncId() returns true. Returns -1 if not applicable (this value only applies to assigning replica shards).
    • getStoreException

      @Nullable public Exception getStoreException()
      Gets the store exception when trying to read the store, if there was an error. If there was no error, returns null.
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent