Class SearchResponse.Clusters

All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment
Enclosing class:

public static class SearchResponse.Clusters
extends java.lang.Object
implements ToXContentFragment, 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.
  • Field Details

  • Constructor Details

    • Clusters

      public Clusters​(int total, int successful, int skipped)
  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws
      Specified by:
      toXContent in interface ToXContent
    • 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​(java.lang.Object o)
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      hashCode in class java.lang.Object
    • toString

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