Package org.elasticsearch.cluster.routing.allocation

Class NodeAllocationResult.ShardStoreInfo

java.lang.Object
org.elasticsearch.cluster.routing.allocation.NodeAllocationResult.ShardStoreInfo
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
Enclosing class:
NodeAllocationResult
public static final class NodeAllocationResult.ShardStoreInfo extends Object implements org.elasticsearch.common.xcontent.ToXContentFragment, Writeable
A class that captures metadata about a shard store on a node.

  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShardStoreInfo(long matchingBytes)
     
    ShardStoreInfo(String allocationId, boolean inSync, Exception storeException)
     
    ShardStoreInfo(StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAllocationId()
    Gets the allocation id for the shard copy, if it exists.
    long
    getMatchingBytes()
    Gets the number of matching bytes the shard copy has with the primary shard.
    Exception
    getStoreException()
    Gets the store exception when trying to read the store, if there was an error.
    boolean
    hasMatchingSyncId()
    Returns true if the shard copy has a matching sync id with the primary shard.
    boolean
    isInSync()
    Returns true if the shard copy is in-sync and contains the latest data.
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    void
    writeTo(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • ShardStoreInfo

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

    • ShardStoreInfo

      public ShardStoreInfo(long matchingBytes)

    • ShardStoreInfo

      public ShardStoreInfo(StreamInput in) throws IOException
      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
      Throws:
      IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException