Package co.elastic.clients.elasticsearch.core

Class HealthReportRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.HealthReportRequest

public class HealthReportRequest
extends RequestBase

Returns the health of the cluster.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<HealthReportRequest,HealthReportResponse,ErrorResponse>	_ENDPOINT	Endpoint "health_report".

Method Summary

Modifier and Type	Method	Description
final List<String>	feature()	A feature of the cluster, as returned by the top-level health report API.
static HealthReportRequest	of(Function<HealthReportRequest.Builder,ObjectBuilder<HealthReportRequest>> fn)
final Integer	size()	Limit the number of affected resources the health report API returns.
final Time	timeout()	Explicit operation timeout.
final Boolean	verbose()	Opt-in for more information about the health of the system.

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<HealthReportRequest,HealthReportResponse,ErrorResponse> _ENDPOINT

Endpoint "health_report".

Method Details

of

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

feature

public final List<String> feature()

A feature of the cluster, as returned by the top-level health report API.

API name: feature

size

@Nullable
public final Integer size()

Limit the number of affected resources the health report API returns.

API name: size

timeout

@Nullable
public final Time timeout()

Explicit operation timeout.

API name: timeout

verbose

@Nullable
public final Boolean verbose()

Opt-in for more information about the health of the system.

API name: verbose