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
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.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 inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
int
Returns how many total clusters were during the execution of the search requestint
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()
toString()
toXContent
(XContentBuilder builder, ToXContent.Params params) void
writeTo
(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.xcontent.ToXContentFragment
isFragment
-
Field Details
-
EMPTY
-
-
Constructor Details
-
Clusters
public Clusters(int total, int successful, int skipped)
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in 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 -
equals
-
hashCode
public int hashCode() -
toString
-