Class UpdateByQueryRethrottleRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>
org.opensearch.client.opensearch.core.UpdateByQueryRethrottleRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<UpdateByQueryRethrottleRequest.Builder,,UpdateByQueryRethrottleRequest> MutableBuilder<UpdateByQueryRethrottleRequest.Builder,,UpdateByQueryRethrottleRequest> ObjectBuilder<UpdateByQueryRethrottleRequest>
- Enclosing class:
UpdateByQueryRethrottleRequest
public static class UpdateByQueryRethrottleRequest.Builder
extends RequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>
implements CopyableBuilder<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest>
Builder for
UpdateByQueryRethrottleRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aUpdateByQueryRethrottleRequest.copy()Create a new builderCopyableBuilderthat is a copy of this one.requestsPerSecond(Float value) The throttle for this request in sub-requests per second.protected UpdateByQueryRethrottleRequest.Builderself()Required - The ID for the task.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<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>
-
requestsPerSecond
@Nonnull public final UpdateByQueryRethrottleRequest.Builder requestsPerSecond(@Nullable Float value) The throttle for this request in sub-requests per second.API name:
requests_per_second -
taskId
Required - The ID for the task.API name:
task_id -
build
Builds aUpdateByQueryRethrottleRequest.- Specified by:
buildin interfaceObjectBuilder<UpdateByQueryRethrottleRequest>- Throws:
NullPointerException- if some of the required fields are null.
-