Class ListRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.tasks.ListRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<ListRequest>
- Enclosing class:
- ListRequest
public static class ListRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<ListRequest>
Builder for
ListRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ListRequest.Builder
actions(java.lang.String value, java.lang.String... values)
Comma-separated list or wildcard expression of actions used to limit the request.ListRequest.Builder
actions(java.util.List<java.lang.String> list)
Comma-separated list or wildcard expression of actions used to limit the request.ListRequest
build()
Builds aListRequest
.ListRequest.Builder
detailed(java.lang.Boolean value)
Iftrue
, the response includes detailed information about shard recoveries.ListRequest.Builder
groupBy(GroupBy value)
Key used to group tasks in the response.ListRequest.Builder
masterTimeout(Time value)
Period to wait for a connection to the master node.ListRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a connection to the master node.ListRequest.Builder
nodeId(java.lang.String value, java.lang.String... values)
Comma-separated list of node IDs or names used to limit returned information.ListRequest.Builder
nodeId(java.util.List<java.lang.String> list)
Comma-separated list of node IDs or names used to limit returned information.ListRequest.Builder
parentTaskId(java.lang.String value)
Parent task ID used to limit returned information.ListRequest.Builder
timeout(Time value)
Period to wait for a response.ListRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a response.ListRequest.Builder
waitForCompletion(java.lang.Boolean value)
Iftrue
, the request blocks until the operation is complete.Methods inherited from class co.elastic.clients.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 Details
-
Builder
public Builder()
-
-
Method Details
-
actions
Comma-separated list or wildcard expression of actions used to limit the request.API name:
actions
Adds all elements of
list
toactions
. -
actions
Comma-separated list or wildcard expression of actions used to limit the request.API name:
actions
Adds one or more values to
actions
. -
detailed
Iftrue
, the response includes detailed information about shard recoveries.API name:
detailed
-
groupBy
Key used to group tasks in the response.API name:
group_by
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
masterTimeout
public final ListRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
nodeId
Comma-separated list of node IDs or names used to limit returned information.API name:
node_id
Adds all elements of
list
tonodeId
. -
nodeId
Comma-separated list of node IDs or names used to limit returned information.API name:
node_id
Adds one or more values to
nodeId
. -
parentTaskId
Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of-1
.API name:
parent_task_id
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
timeout
public final ListRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
waitForCompletion
Iftrue
, the request blocks until the operation is complete.API name:
wait_for_completion
-
build
Builds aListRequest
.- Specified by:
build
in interfaceObjectBuilder<ListRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-