UpdateByQueryRethrottleRequest.Builder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch.core.UpdateByQueryRethrottleRequest.Builder

All Implemented Interfaces:

ObjectBuilder<UpdateByQueryRethrottleRequest>

Enclosing class:

UpdateByQueryRethrottleRequest
```
public static class UpdateByQueryRethrottleRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<UpdateByQueryRethrottleRequest>
```
Builder for UpdateByQueryRethrottleRequest.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`UpdateByQueryRethrottleRequest`	`build()`	Builds a `UpdateByQueryRethrottleRequest`.
`UpdateByQueryRethrottleRequest.Builder`	`requestsPerSecond(java.lang.Long value)`	The throttle to set on this request in floating sub-requests per second.
`UpdateByQueryRethrottleRequest.Builder`	`taskId(java.lang.String value)`	Required - The task id to rethrottle

Methods inherited from class org.opensearch.client.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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - requestsPerSecond
```
public final UpdateByQueryRethrottleRequest.Builder requestsPerSecond(@Nullable
                                                                      java.lang.Long value)
```
    The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
    API name: requests_per_second
  - taskId
```
public final UpdateByQueryRethrottleRequest.Builder taskId(java.lang.String value)
```
    Required - The task id to rethrottle
    API name: task_id
  - build
```
public UpdateByQueryRethrottleRequest build()
```
    Builds a UpdateByQueryRethrottleRequest.
    
    Specified by:
    
    build in interface ObjectBuilder<UpdateByQueryRethrottleRequest>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.