Class ListRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.tasks.ListRequest
public class ListRequest extends RequestBase
Returns a list of tasks.
- 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()
A comma-separated list of actions that should be returned.java.lang.Boolean
detailed()
Return detailed task information (default: false)GroupBy
groupBy()
Group tasks by nodes or parent/child relationshipsjava.util.List<java.lang.String>
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 nodesstatic ListRequest
of(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
java.lang.String
parentTaskId()
Return tasks with specified parent task id (node_id:task_number).Time
timeout()
Explicit operation timeoutjava.lang.Boolean
waitForCompletion()
Wait for the matching tasks to complete (default: false)Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()A comma-separated list of actions that should be returned. Leave empty to return all.API name:
actions
-
detailed
@Nullable public final java.lang.Boolean detailed()Return detailed task information (default: false)API name:
detailed
-
groupBy
Group tasks by nodes or parent/child relationshipsAPI name:
group_by
-
nodes
public final java.util.List<java.lang.String> 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
-
parentTaskId
@Nullable public final java.lang.String 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
-
waitForCompletion
@Nullable public final java.lang.Boolean waitForCompletion()Wait for the matching tasks to complete (default: false)API name:
wait_for_completion
-