Package org.opensearch.client.opensearch.cat

Class HealthRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<HealthRequest.Builder>

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<HealthRequest.Builder>

org.opensearch.client.opensearch.cat.HealthRequest.Builder

All Implemented Interfaces:

CopyableBuilder<HealthRequest.Builder,HealthRequest>, MutableBuilder<HealthRequest.Builder,HealthRequest>, ObjectBuilder<HealthRequest>

Enclosing class:

HealthRequest

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

Builder for HealthRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HealthRequest	build()	Builds a HealthRequest.
HealthRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected HealthRequest.Builder	self()
final HealthRequest.Builder	time(TimeUnit value)	The unit used to display time values.
final HealthRequest.Builder	ts(Boolean value)	When true, returns HH:MM:SS and Unix epoch timestamps.

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

headers, headers, sort, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public HealthRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<HealthRequest.Builder,HealthRequest>

Returns:

a new builder instance.

self

@Nonnull
protected HealthRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<HealthRequest.Builder>

time

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

The unit used to display time values.

API name: time

ts

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

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

API name: ts

build

@Nonnull
public HealthRequest build()

Builds a HealthRequest.

Specified by:

build in interface ObjectBuilder<HealthRequest>

Throws:

NullPointerException - if some of the required fields are null.