Class LtrStatsRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<LtrStatsRequest.Builder>
org.opensearch.client.opensearch.ltr.LtrStatsRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<LtrStatsRequest.Builder,,LtrStatsRequest> MutableBuilder<LtrStatsRequest.Builder,,LtrStatsRequest> ObjectBuilder<LtrStatsRequest>
- Enclosing class:
LtrStatsRequest
public static class LtrStatsRequest.Builder
extends RequestBase.AbstractBuilder<LtrStatsRequest.Builder>
implements CopyableBuilder<LtrStatsRequest.Builder,LtrStatsRequest>
Builder for
LtrStatsRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aLtrStatsRequest.copy()Create a new builderCopyableBuilderthat is a copy of this one.final LtrStatsRequest.BuilderA comma-separated list of node IDs or names to limit the returned information; use_localto return information from the node you're connecting to, leave empty to get information from all nodes.final LtrStatsRequest.BuilderA comma-separated list of node IDs or names to limit the returned information; use_localto return information from the node you're connecting to, leave empty to get information from all nodes.protected LtrStatsRequest.Builderself()final LtrStatsRequest.Builderstat(List<LtrStatName> list) A comma-separated list of stats to retrieve; use_allor empty string to retrieve all stats.final LtrStatsRequest.Builderstat(LtrStatName value, LtrStatName... values) A comma-separated list of stats to retrieve; use_allor empty string to retrieve all stats.final LtrStatsRequest.BuilderThe time in milliseconds to wait for a response.final LtrStatsRequest.BuilderThe time in milliseconds to wait for a response.Methods 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<LtrStatsRequest.Builder,LtrStatsRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<LtrStatsRequest.Builder>
-
nodeId
A comma-separated list of node IDs or names to limit the returned information; use_localto return information from the node you're connecting to, leave empty to get information from all nodes.API name:
node_idAdds all elements of
listtonodeId. -
nodeId
A comma-separated list of node IDs or names to limit the returned information; use_localto return information from the node you're connecting to, leave empty to get information from all nodes.API name:
node_idAdds one or more values to
nodeId. -
stat
A comma-separated list of stats to retrieve; use_allor empty string to retrieve all stats.API name:
statAdds all elements of
listtostat. -
stat
A comma-separated list of stats to retrieve; use_allor empty string to retrieve all stats.API name:
statAdds one or more values to
stat. -
timeout
The time in milliseconds to wait for a response.API name:
timeout -
timeout
@Nonnull public final LtrStatsRequest.Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) The time in milliseconds to wait for a response.API name:
timeout -
build
Builds aLtrStatsRequest.- Specified by:
buildin interfaceObjectBuilder<LtrStatsRequest>- Throws:
NullPointerException- if some of the required fields are null.
-