Package org.opensearch.action.search

Class SearchResponse.Clusters

java.lang.Object
org.opensearch.action.search.SearchResponse.Clusters
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
Enclosing class:
SearchResponse
@PublicApi(since="1.0.0") public static class SearchResponse.Clusters extends Object implements org.opensearch.core.xcontent.ToXContentFragment, org.opensearch.core.common.io.stream.Writeable
Holds info about the clusters that the search was executed on: how many in total, how many of them were successful and how many of them were skipped.
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
    Modifier and Type
    Field
    Description
    static final SearchResponse.Clusters
    EMPTY
     

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    Clusters(int total, int successful, int skipped)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    getSkipped()
    Returns how many total clusters were during the execution of the search request
    int
    getSuccessful()
    Returns how many total clusters the search was executed successfully on
    int
    getTotal()
    Returns how many total clusters the search was requested to be executed on
    int
    hashCode()
     
    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, finalize, getClass, notify, notifyAll, wait, wait, wait

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

    isFragment

  • Field Details

  • Constructor Details

    • Clusters

      public Clusters(int total, int successful, int skipped)

  • 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

    • 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

    • getTotal

      public int getTotal()
      Returns how many total clusters the search was requested to be executed on

    • getSuccessful

      public int getSuccessful()
      Returns how many total clusters the search was executed successfully on

    • getSkipped

      public int getSkipped()
      Returns how many total clusters were during the execution of the search request

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object