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