Package org.opensearch.client.opensearch.cat

Class CountRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.CountRequest

All Implemented Interfaces:

ToCopyableBuilder<CountRequest.Builder,CountRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CountRequest
extends CatRequestBase
implements ToCopyableBuilder<CountRequest.Builder,CountRequest>

Provides quick access to the document count of the entire cluster or of an individual index.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.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
static CountRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	index()	Comma-separated list of data streams, indexes, and aliases used to limit the request.
static CountRequest	of(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
CountRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

applyQueryParameters, headers, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

index

@Nonnull
public final List<String> index()

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

toBuilder

@Nonnull
public CountRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CountRequest.Builder,CountRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CountRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object