Package co.elastic.clients.elasticsearch.cluster

Class PendingTasksRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cluster.PendingTasksRequest

public class PendingTasksRequest
extends RequestBase

Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

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:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<PendingTasksRequest,PendingTasksResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.pending_tasks".

Method Summary

Modifier and Type	Method	Description
final Boolean	local()	If true, the request retrieves information from the local node only.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static PendingTasksRequest	of(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)

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<PendingTasksRequest,PendingTasksResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.pending_tasks".

Method Details

of

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

local

@Nullable
public final Boolean local()

If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

API name: local

masterTimeout

@Nullable
public final Time 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