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

All Implemented Interfaces:

ToCopyableBuilder<TasksRequest.Builder,TasksRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class TasksRequest
extends CatRequestBase
implements ToCopyableBuilder<TasksRequest.Builder,TasksRequest>

Lists the progress of all tasks currently running on 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.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 used to limit the response.
protected void	applyQueryParameters(Map<String,String> params)
static TasksRequest.Builder	builder()
final Boolean	detailed()	If true, the response includes detailed information about shard recoveries.
boolean	equals(Object o)
int	hashCode()
final List<String>	nodes()	A comma-separated list of node IDs or names used to limit the returned information.
static TasksRequest	of(Function<TasksRequest.Builder,ObjectBuilder<TasksRequest>> fn)
final String	parentTaskId()	The parent task identifier, which is used to limit the response.
final TimeUnit	time()	Specifies the time units, for example, 5d or 7h.
TasksRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

headers, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

@Nonnull
public final List<String> actions()

The task action names 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

nodes

@Nonnull
public final List<String> nodes()

A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes.

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

time

@Nullable
public final TimeUnit time()

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

toBuilder

@Nonnull
public TasksRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TasksRequest.Builder,TasksRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static TasksRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object