Class ListRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ListRequest.Builder>
co.elastic.clients.elasticsearch.tasks.ListRequest.Builder
- All Implemented Interfaces:
WithJson<ListRequest.Builder>
,ObjectBuilder<ListRequest>
- Enclosing class:
- ListRequest
public static class ListRequest.Builder
extends RequestBase.AbstractBuilder<ListRequest.Builder>
implements ObjectBuilder<ListRequest>
Builder for
ListRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ListRequest.Builder
A comma-separated list of actions that should be returned.final ListRequest.Builder
A comma-separated list of actions that should be returned.build()
Builds aListRequest
.final ListRequest.Builder
Return detailed task information (default: false)final ListRequest.Builder
Group tasks by nodes or parent/child relationshipsfinal ListRequest.Builder
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 nodesfinal ListRequest.Builder
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 nodesfinal ListRequest.Builder
parentTaskId
(String value) Return tasks with specified parent task id (node_id:task_number).protected ListRequest.Builder
self()
final ListRequest.Builder
Explicit operation timeoutfinal ListRequest.Builder
Explicit operation timeoutfinal ListRequest.Builder
waitForCompletion
(Boolean value) Wait for the matching tasks to complete (default: false)Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
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
Explicit operation timeoutAPI name:
timeout
-
waitForCompletion
Wait for the matching tasks to complete (default: false)API name:
wait_for_completion
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ListRequest.Builder>
-
build
Builds aListRequest
.- Specified by:
build
in interfaceObjectBuilder<ListRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-