Class PendingTasksRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.PendingTasksRequest
Returns cluster-level changes (such as create index, update mapping, allocate
or fail shard) that have not yet been executed. NOTE: This API returns a list
of any pending updates to the cluster state. These are distinct from the
tasks reported by the Task Management API which include periodic tasks and
tasks initiated by the user, such as node stats, search queries, or create
index requests. However, if a user-initiated task such as a create index
command causes a cluster state update, the activity of this task might be
reported by both task api and pending cluster tasks API.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<PendingTasksRequest,
PendingTasksResponse, ErrorResponse> Endpoint "cluster.pending_tasks
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
local()
Iftrue
, the request retrieves information from the local node only.final Time
Period to wait for a connection to the master node.static PendingTasksRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cluster.pending_tasks
".
-
-
Method Details
-
of
public static PendingTasksRequest of(Function<PendingTasksRequest.Builder, ObjectBuilder<PendingTasksRequest>> fn) -
local
Iftrue
, the request retrieves information from the local node only. Iffalse
, information is retrieved from the master node.API name:
local
-
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
-