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)
A comma-separated list of actions that should be returned.ListRequest.Builder
actions(java.util.List<java.lang.String> list)
A comma-separated list of actions that should be returned.ListRequest
build()
Builds aListRequest
.ListRequest.Builder
detailed(java.lang.Boolean value)
Return detailed task information (default: false)ListRequest.Builder
groupBy(GroupBy value)
Group tasks by nodes or parent/child relationshipsListRequest.Builder
nodes(java.lang.String value, java.lang.String... values)
A comma-separated list of node IDs or names to limit the returned information; use_local
to return information from the node you're connecting to, leave empty to get information from all nodesListRequest.Builder
nodes(java.util.List<java.lang.String> list)
A comma-separated list of node IDs or names to limit the returned information; use_local
to return information from the node you're connecting to, leave empty to get information from all nodesListRequest.Builder
parentTaskId(java.lang.String value)
Return tasks with specified parent task id (node_id:task_number).ListRequest.Builder
timeout(Time value)
Explicit operation timeoutListRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Explicit operation timeoutListRequest.Builder
waitForCompletion(java.lang.Boolean value)
Wait for the matching tasks to complete (default: false)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
A comma-separated list of actions that should be returned. Leave empty to return all.API name:
actions
Adds all elements of
list
toactions
. -
actions
A comma-separated list of actions that should be returned. Leave empty to return all.API name:
actions
Adds one or more values to
actions
. -
detailed
Return detailed task information (default: false)API name:
detailed
-
groupBy
Group tasks by nodes or parent/child relationshipsAPI name:
group_by
-
nodes
A comma-separated list of node IDs or names to limit the returned information; use_local
to return information from the node you're connecting to, leave empty to get information from all nodesAPI name:
nodes
Adds all elements of
list
tonodes
. -
nodes
A comma-separated list of node IDs or names to limit the returned information; use_local
to return information from the node you're connecting to, leave empty to get information from all nodesAPI name:
nodes
Adds one or more values to
nodes
. -
parentTaskId
Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.API name:
parent_task_id
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
public final ListRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Explicit operation timeoutAPI name:
timeout
-
waitForCompletion
Wait for the matching tasks to complete (default: false)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.
-