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 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.ClustersEMPTY-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description Clusters(int total, int successful, int skipped)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)intgetSkipped()Returns how many total clusters were during the execution of the search requestintgetSuccessful()Returns how many total clusters the search was executed successfully onintgetTotal()Returns how many total clusters the search was requested to be executed oninthashCode()StringtoString()XContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params)voidwriteTo(StreamOutput out)Write this into the StreamOutput.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Field Detail
-
EMPTY
public static final SearchResponse.Clusters EMPTY
-
-
Method Detail
-
writeTo
public void writeTo(StreamOutput out) throws IOException
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
- Specified by:
toXContentin interfaceToXContent- 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
-
-