Package co.elastic.clients.elasticsearch.cat

Class HealthRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.HealthRequest

public class HealthRequest
extends CatRequestBase

Get the cluster health status.

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 cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<HealthRequest,HealthResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.health".

Method Summary

Modifier and Type	Method	Description
final List<String>	h()	List of columns to appear in the response.
static HealthRequest	of(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
final List<String>	s()	List of columns that determine how the table should be sorted.
final TimeUnit	time()	The unit used to display time values.
final Boolean	ts()	If true, returns HH:MM:SS and Unix epoch timestamps.

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

Endpoint "cat.health".

Method Details

of

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

h

public final List<String> h()

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

API name: h

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

time

@Nullable
public final TimeUnit time()

The unit used to display time values.

API name: time

ts

@Nullable
public final Boolean ts()

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

API name: ts