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

Provides quick access to the document count of the entire cluster, or individual indices.

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 Endpoint<CountRequest,CountResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.count".

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	index()	A comma-separated list of index names to limit the returned information
static CountRequest	of(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

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

Endpoint "cat.count".

Method Details

of

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

index

public final java.util.List<java.lang.String> index()

A comma-separated list of index names to limit the returned information

API name: index