Package org.elasticsearch.action.search
Class SearchResponse.Clusters
java.lang.Object
org.elasticsearch.action.search.SearchResponse.Clusters
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentFragment
- Enclosing class:
- SearchResponse
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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static SearchResponse.Clusters
EMPTY
-
Constructor Summary
Constructors Constructor Description Clusters(int total, int successful, int skipped)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
int
getSkipped()
Returns how many total clusters were during the execution of the search requestint
getSuccessful()
Returns how many total clusters the search was executed successfully onint
getTotal()
Returns how many total clusters the search was requested to be executed onint
hashCode()
java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
Constructor Details
-
Clusters
public Clusters(int total, int successful, int skipped)
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.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(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-