TasksRequest (java-client 7.17.5 API)

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

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

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 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 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(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