Package co.elastic.clients.elasticsearch.cat

Class TasksRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.TasksRequest

public class TasksRequest
extends CatRequestBase

Get task information.

Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TasksRequest.Builder	Builder for TasksRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<TasksRequest,TasksResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.tasks".

Method Summary

Modifier and Type	Method	Description
final List<String>	actions()	The task action names, which are used to limit the response.
final Boolean	detailed()	If true, the response includes detailed information about shard recoveries.
final List<String>	h()	List of columns to appear in the response.
final List<String>	nodes()	Unique node identifiers, which are used to limit the response.
static TasksRequest	of(Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)
final String	parentTaskId()	The parent task identifier, which is used to limit the response.
final List<String>	s()	List of columns that determine how the table should be sorted.
final TimeUnit	time()	Unit used to display time values.
final Time	timeout()	Period to wait for a response.
final Boolean	waitForCompletion()	If true, the request blocks until the task has completed.

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<TasksRequest,TasksResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.tasks".

Method Details

of

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

actions

public final List<String> actions()

The task action names, which are used to limit the response.

API name: actions

detailed

@Nullable
public final Boolean detailed()

If true, the response includes detailed information about shard recoveries.

API name: detailed

h

public final List<String> h()

List of columns to appear in the response. Supports simple wildcards.

API name: h

nodes

public final List<String> nodes()

Unique node identifiers, which are used to limit the response.

API name: nodes

parentTaskId

@Nullable
public final String parentTaskId()

The parent task identifier, which is used to limit the response.

API name: parent_task_id

s

public final List<String> s()

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s

time

@Nullable
public final TimeUnit time()

Unit used to display time values.

API name: time

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 task has completed.

API name: wait_for_completion