Package co.elastic.clients.elasticsearch.tasks

Class ListRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.tasks.ListRequest

public class ListRequest
extends RequestBase

Get all tasks. Get information about the tasks currently running 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 for ListRequest.

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 final Endpoint<ListRequest,ListResponse,ErrorResponse>	_ENDPOINT	Endpoint "tasks.list".

Method Summary

Modifier and Type	Method	Description
final List<String>	actions()	Comma-separated list or wildcard expression of actions used to limit the request.
final Boolean	detailed()	If true, the response includes detailed information about shard recoveries.
final GroupBy	groupBy()	Key used to group tasks in the response.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final List<String>	nodes()	Comma-separated list of node IDs or names used to limit returned information.
static ListRequest	of(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
final String	parentTaskId()	Parent task ID used to limit returned information.
final Time	timeout()	Period to wait for a response.
final Boolean	waitForCompletion()	If true, 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

public static final Endpoint<ListRequest,ListResponse,ErrorResponse> _ENDPOINT

Endpoint "tasks.list".

Method Details

of

public static ListRequest of(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

actions

public final List<String> actions()

Comma-separated list or wildcard expression of actions used to limit the request.

API name: actions

detailed

@Nullable
public final Boolean detailed()

If true, the response includes detailed information about shard recoveries. This information is useful to distinguish tasks from each other but is more costly to run.

API name: detailed

groupBy

@Nullable
public final GroupBy groupBy()

Key used to group tasks in the response.

API name: group_by

masterTimeout

@Nullable
public final Time 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

nodes

public final List<String> nodes()

Comma-separated list of node IDs or names used to limit returned information.

API name: nodes

parentTaskId

@Nullable
public final 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

@Nullable
public final Time 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 Boolean waitForCompletion()

If true, the request blocks until the operation is complete.

API name: wait_for_completion