Package co.elastic.clients.elasticsearch.cat

Class HealthRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<HealthRequest.Builder>

co.elastic.clients.elasticsearch.cat.HealthRequest.Builder

All Implemented Interfaces:

WithJson<HealthRequest.Builder>, ObjectBuilder<HealthRequest>

Enclosing class:

HealthRequest

public static class HealthRequest.Builder
extends CatRequestBase.AbstractBuilder<HealthRequest.Builder>
implements ObjectBuilder<HealthRequest>

Builder for HealthRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HealthRequest	build()	Builds a HealthRequest.
final HealthRequest.Builder	h(CatHealthColumn value, CatHealthColumn... values)	A comma-separated list of columns names to display.
final HealthRequest.Builder	h(String value, String... values)	A comma-separated list of columns names to display.
final HealthRequest.Builder	h(List<String> list)	A comma-separated list of columns names to display.
final HealthRequest.Builder	s(String value, String... values)	List of columns that determine how the table should be sorted.
final HealthRequest.Builder	s(List<String> list)	List of columns that determine how the table should be sorted.
protected HealthRequest.Builder	self()
final HealthRequest.Builder	time(TimeUnit value)	The unit used to display time values.
final HealthRequest.Builder	ts(Boolean value)	If true, returns HH:MM:SS and Unix epoch timestamps.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

h

public final HealthRequest.Builder h(List<String> list)

A comma-separated list of columns names to display. It supports simple wildcards.

API name: h

Adds all elements of list to h.

h

public final HealthRequest.Builder h(String value,
 String... values)

A comma-separated list of columns names to display. It supports simple wildcards.

API name: h

Adds one or more values to h.

h

public final HealthRequest.Builder h(CatHealthColumn value,
 CatHealthColumn... values)

A comma-separated list of columns names to display. It supports simple wildcards.

API name: h

Adds one or more enum values to h.

s

public final HealthRequest.Builder s(List<String> list)

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

Adds all elements of list to s.

s

public final HealthRequest.Builder s(String value,
 String... values)

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

Adds one or more values to s.

time

public final HealthRequest.Builder time(@Nullable
 TimeUnit value)

The unit used to display time values.

API name: time

ts

public final HealthRequest.Builder ts(@Nullable
 Boolean value)

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

API name: ts

self

protected HealthRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<HealthRequest.Builder>

build

public HealthRequest build()

Builds a HealthRequest.

Specified by:

build in interface ObjectBuilder<HealthRequest>

Throws:

NullPointerException - if some of the required fields are null.