Package org.opensearch.client.opensearch.cat

Class TasksRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.TasksRequest

public class TasksRequest
extends CatRequestBase

Returns information about the tasks currently executing on one or more nodes in the cluster.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

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)
java.util.List<java.lang.String>	nodeId()	API name: node_id
static TasksRequest	of(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)
java.lang.Long	parentTask()	API name: parent_task

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

headers, queryParameters, sort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<TasksRequest,TasksResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.tasks".

Method Detail

of

public static TasksRequest of(java.util.function.Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> 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

nodeId

public final java.util.List<java.lang.String> nodeId()

API name: node_id

parentTask

@Nullable
public final java.lang.Long parentTask()

API name: parent_task