Package org.opensearch.client.opensearch.cat

Class HealthRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.HealthRequest

public class HealthRequest
extends CatRequestBase

Returns a concise representation of the cluster health.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<HealthRequest,HealthResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.health".

Method Summary

Modifier and Type	Method	Description
static HealthRequest	of(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
java.lang.Boolean	ts()	Set to false to disable timestamping

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

headers, queryParameters, sort

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<HealthRequest,HealthResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.health".

Method Detail

of

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

ts

@Nullable
public final java.lang.Boolean ts()

Set to false to disable timestamping

API name: ts