Package co.elastic.clients.elasticsearch.cat

Class CountRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.CountRequest

public class CountRequest
extends CatRequestBase

Get a document count.

Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CountRequest.Builder	Builder for CountRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<CountRequest,CountResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.count".

Method Summary

Modifier and Type	Method	Description
final List<String>	h()	List of columns to appear in the response.
final List<String>	index()	A comma-separated list of data streams, indices, and aliases used to limit the request.
static CountRequest	of(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
final List<String>	s()	List of columns that determine how the table should be sorted.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<CountRequest,CountResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.count".

Method Details

of

public static CountRequest of(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)

h

public final List<String> h()

List of columns to appear in the response. Supports simple wildcards.

API name: h

index

public final List<String> index()

A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

API name: index

s

public final List<String> s()

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s