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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aHealthRequest.copy()Create a new builderCopyableBuilderthat is a copy of this one.protected HealthRequest.Builderself()final HealthRequest.BuilderThe unit used to display time values.final HealthRequest.BuilderWhentrue, returnsHH:MM:SSand Unix epoch timestamps.Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder
headers, headers, sort, sortMethods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder
errorTrace, humanMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<HealthRequest.Builder,HealthRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<HealthRequest.Builder>
-
time
The unit used to display time values.API name:
time -
ts
Whentrue, returnsHH:MM:SSand Unix epoch timestamps.API name:
ts -
build
Builds aHealthRequest.- Specified by:
buildin interfaceObjectBuilder<HealthRequest>- Throws:
NullPointerException- if some of the required fields are null.
-