|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.elasticsearch.action.search.SearchResponse
public class SearchResponse
A response of a search request.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent |
---|
ToXContent.MapParams, ToXContent.Params |
Field Summary |
---|
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent |
---|
EMPTY_PARAMS |
Constructor Summary | |
---|---|
SearchResponse()
|
|
SearchResponse(InternalSearchResponse internalResponse,
String scrollId,
int totalShards,
int successfulShards,
long tookInMillis,
ShardSearchFailure[] shardFailures)
|
Method Summary | |
---|---|
Facets |
facets()
The search facets. |
int |
failedShards()
The failed number of shards the search was executed on. |
Facets |
getFacets()
The search facets. |
int |
getFailedShards()
The failed number of shards the search was executed on. |
SearchHits |
getHits()
The search hits. |
String |
getScrollId()
If scrolling was enabled ( SearchRequest.scroll(org.elasticsearch.search.Scroll) , the
scroll id that can be used to continue scrolling. |
ShardSearchFailure[] |
getShardFailures()
The failures that occurred during the search. |
int |
getSuccessfulShards()
The successful number of shards the search was executed on. |
TimeValue |
getTook()
How long the search took. |
long |
getTookInMillis()
How long the search took in milliseconds. |
int |
getTotalShards()
The total number of shards the search was executed on. |
SearchHits |
hits()
The search hits. |
boolean |
isTimedOut()
Has the search operation timed out. |
void |
readFrom(StreamInput in)
|
static SearchResponse |
readSearchResponse(StreamInput in)
|
String |
scrollId()
If scrolling was enabled ( SearchRequest.scroll(org.elasticsearch.search.Scroll) , the
scroll id that can be used to continue scrolling. |
ShardSearchFailure[] |
shardFailures()
The failures that occurred during the search. |
RestStatus |
status()
|
int |
successfulShards()
The successful number of shards the search was executed on. |
boolean |
timedOut()
Has the search operation timed out. |
TimeValue |
took()
How long the search took. |
long |
tookInMillis()
How long the search took in milliseconds. |
String |
toString()
|
int |
totalShards()
The total number of shards the search was executed on. |
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params)
|
void |
writeTo(StreamOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchResponse()
public SearchResponse(InternalSearchResponse internalResponse, String scrollId, int totalShards, int successfulShards, long tookInMillis, ShardSearchFailure[] shardFailures)
Method Detail |
---|
public RestStatus status()
public SearchHits hits()
public SearchHits getHits()
public Facets facets()
public Facets getFacets()
public boolean timedOut()
public boolean isTimedOut()
public TimeValue took()
public TimeValue getTook()
public long tookInMillis()
public long getTookInMillis()
public int totalShards()
public int getTotalShards()
public int successfulShards()
public int getSuccessfulShards()
public int failedShards()
public int getFailedShards()
public ShardSearchFailure[] shardFailures()
public ShardSearchFailure[] getShardFailures()
public String scrollId()
SearchRequest.scroll(org.elasticsearch.search.Scroll)
, the
scroll id that can be used to continue scrolling.
public String getScrollId()
SearchRequest.scroll(org.elasticsearch.search.Scroll)
, the
scroll id that can be used to continue scrolling.
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
toXContent
in interface ToXContent
IOException
public static SearchResponse readSearchResponse(StreamInput in) throws IOException
IOException
public void readFrom(StreamInput in) throws IOException
readFrom
in interface Streamable
IOException
public void writeTo(StreamOutput out) throws IOException
writeTo
in interface Streamable
IOException
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |