Class ListRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.tasks.ListRequest
The task management API returns information about tasks currently executing
on one or more nodes in the cluster.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<ListRequest,
ListResponse, ErrorResponse> Endpoint "tasks.list
". -
Method Summary
Modifier and TypeMethodDescriptionactions()
Comma-separated list or wildcard expression of actions used to limit the request.final Boolean
detailed()
Iftrue
, the response includes detailed information about shard recoveries.final GroupBy
groupBy()
Key used to group tasks in the response.final Time
Period to wait for a connection to the master node.nodeId()
Comma-separated list of node IDs or names used to limit returned information.static ListRequest
final String
Parent task ID used to limit returned information.final Time
timeout()
Period to wait for a response.final Boolean
Iftrue
, the request blocks until the operation is complete.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "tasks.list
".
-
-
Method Details
-
of
-
actions
Comma-separated list or wildcard expression of actions used to limit the request.API name:
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
-
nodeId
Comma-separated list of node IDs or names used to limit returned information.API name:
node_id
-
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
-
waitForCompletion
Iftrue
, the request blocks until the operation is complete.API name:
wait_for_completion
-