Package org.elasticsearch.client.core

Class CountResponse

java.lang.Object

org.elasticsearch.client.core.CountResponse

public final class CountResponse
extends Object

A response to _count API request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CountResponse.ShardStats	Encapsulates _shards section of count api response.

Constructor Summary

Constructors

Constructor	Description
CountResponse(long count, Boolean terminatedEarly, CountResponse.ShardStats shardStats)

Method Summary

Modifier and Type	Method	Description
static CountResponse	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
long	getCount()	Number of documents matching request.
int	getFailedShards()	The failed number of shards the search was executed on.
org.elasticsearch.action.search.ShardSearchFailure[]	getShardFailures()	The failures that occurred during the search.
CountResponse.ShardStats	getShardStats()
int	getSkippedShards()	The number of shards skipped due to pre-filtering
int	getSuccessfulShards()	The successful number of shards the search was executed on.
int	getTotalShards()	The total number of shards the search was executed on.
Boolean	isTerminatedEarly()
org.elasticsearch.rest.RestStatus	status()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CountResponse

public CountResponse(long count,
 Boolean terminatedEarly,
 CountResponse.ShardStats shardStats)

Method Details

getShardStats

public CountResponse.ShardStats getShardStats()

getCount

public long getCount()

Number of documents matching request.

getTotalShards

public int getTotalShards()

The total number of shards the search was executed on.

getSuccessfulShards

public int getSuccessfulShards()

The successful number of shards the search was executed on.

getSkippedShards

public int getSkippedShards()

The number of shards skipped due to pre-filtering

getFailedShards

public int getFailedShards()

The failed number of shards the search was executed on.

getShardFailures

public org.elasticsearch.action.search.ShardSearchFailure[] getShardFailures()

The failures that occurred during the search.

status

public org.elasticsearch.rest.RestStatus status()

fromXContent

public static CountResponse fromXContent(org.elasticsearch.xcontent.XContentParser parser)
                                  throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

isTerminatedEarly

public Boolean isTerminatedEarly()