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.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 final SearchResponse.Clusters	EMPTY

Fields inherited from interface org.elasticsearch.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()
XContentBuilder	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

public static final SearchResponse.Clusters EMPTY

Constructor Details

Clusters

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

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface 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