Package org.opensearch.action.admin.indices.close

Class CloseIndexResponse.IndexResult

java.lang.Object
org.opensearch.action.admin.indices.close.CloseIndexResponse.IndexResult
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
Enclosing class:
CloseIndexResponse
@PublicApi(since="1.0.0") public static class CloseIndexResponse.IndexResult extends Object implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentFragment
Inner index result
Opensearch.api:

  • Nested Class Summary

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

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

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexResult(org.opensearch.core.index.Index index)
     
    IndexResult(org.opensearch.core.index.Index index, Exception failure)
     
    IndexResult(org.opensearch.core.index.Index index, CloseIndexResponse.ShardResult[] shards)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Exception
    getException()
     
    org.opensearch.core.index.Index
    getIndex()
     
    CloseIndexResponse.ShardResult[]
    getShards()
     
    boolean
    hasFailures()
     
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • IndexResult

      public IndexResult(org.opensearch.core.index.Index index)

    • IndexResult

      public IndexResult(org.opensearch.core.index.Index index, Exception failure)

    • IndexResult

      public IndexResult(org.opensearch.core.index.Index index, CloseIndexResponse.ShardResult[] shards)

  • Method Details

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • getIndex

      public org.opensearch.core.index.Index getIndex()

    • getException

      public Exception getException()

    • getShards

      public CloseIndexResponse.ShardResult[] getShards()

    • hasFailures

      public boolean hasFailures()

    • toXContent

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

    • toString

      public String toString()
      Overrides:
      toString in class Object