Package org.opensearch.client

Class SyncedFlushResponse.ShardFailure

  • All Implemented Interfaces:
    org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment
    Enclosing class:
    SyncedFlushResponse
    public static final class SyncedFlushResponse.ShardFailure
extends java.lang.Object
implements org.opensearch.common.xcontent.ToXContentFragment
    Description of a failed shard copy for an index.

    • Nested Class Summary

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

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String FAILURE_REASON_FIELD  
      static java.lang.String ROUTING_FIELD  
      static java.lang.String SHARD_ID_FIELD  

      • Fields inherited from interface org.opensearch.common.xcontent.ToXContent

        EMPTY_PARAMS

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SyncedFlushResponse.ShardFailure fromXContent​(org.opensearch.common.xcontent.XContentParser parser)  
      java.lang.String getFailureReason()  
      java.util.Map<java.lang.String,​java.lang.Object> getRouting()  
      int getShardId()  
      org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

        isFragment

    • Field Detail

      • SHARD_ID_FIELD

        public static java.lang.String SHARD_ID_FIELD

      • FAILURE_REASON_FIELD

        public static java.lang.String FAILURE_REASON_FIELD

      • ROUTING_FIELD

        public static java.lang.String ROUTING_FIELD

    • Method Detail

      • getShardId

        public int getShardId()
        Returns:
        Id of the shard whose copy failed

      • getFailureReason

        public java.lang.String getFailureReason()
        Returns:
        Reason for failure of the shard copy

      • getRouting

        public java.util.Map<java.lang.String,​java.lang.Object> getRouting()
        Returns:
        Additional information about the failure.

      • toXContent

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

      • fromXContent

        public static SyncedFlushResponse.ShardFailure fromXContent​(org.opensearch.common.xcontent.XContentParser parser)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException