Package org.elasticsearch.action.support.replication

Class ReplicationResponse.ShardInfo

java.lang.Object
org.elasticsearch.action.support.replication.ReplicationResponse.ShardInfo
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
Enclosing class:
ReplicationResponse
public static class ReplicationResponse.ShardInfo
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  ReplicationResponse.ShardInfo.Failure  

    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
    ShardInfo()  
    ShardInfo​(int total, int successful, ReplicationResponse.ShardInfo.Failure... failures)  
    ShardInfo​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    static ReplicationResponse.ShardInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    int getFailed()  
    ReplicationResponse.ShardInfo.Failure[] getFailures()  
    int getSuccessful()  
    int getTotal()  
    RestStatus status()  
    java.lang.String toString()  
    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, wait, wait, wait

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

    isFragment

  • Constructor Details

    • ShardInfo

      public ShardInfo()

    • ShardInfo

      public ShardInfo​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • ShardInfo

      public ShardInfo​(int total, int successful, ReplicationResponse.ShardInfo.Failure... failures)

  • Method Details

    • getTotal

      public int getTotal()
      Returns:
      the total number of shards the write should go to (replicas and primaries). This includes relocating shards, so this number can be higher than the number of shards.

    • getSuccessful

      public int getSuccessful()
      Returns:
      the total number of shards the write succeeded on (replicas and primaries). This includes relocating shards, so this number can be higher than the number of shards.

    • getFailed

      public int getFailed()
      Returns:
      The total number of replication failures.

    • getFailures

      public ReplicationResponse.ShardInfo.Failure[] getFailures()
      Returns:
      The replication failures that have been captured in the case writes have failed on replica shards.

    • status

      public RestStatus status()

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • toXContent

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

    • fromXContent

      public static ReplicationResponse.ShardInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object