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

All Implemented Interfaces:

ToCopyableBuilder<HealthRequest.Builder,HealthRequest>

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

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.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static HealthRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static HealthRequest	of(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
final TimeUnit	time()	The unit used to display time values.
HealthRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	ts()	When true, returns HH:MM:SS and Unix epoch timestamps.

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

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<HealthRequest,HealthResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.health".

Method Details

of

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

time

@Nullable
public final TimeUnit time()

The unit used to display time values.

API name: time

ts

@Nullable
public final Boolean ts()

When true, returns HH:MM:SS and Unix epoch timestamps.

API name: ts

toBuilder

@Nonnull
public HealthRequest.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<HealthRequest.Builder,HealthRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static HealthRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object