Package org.opensearch.client.opensearch.cluster

Class PendingTasksRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.PendingTasksRequest

All Implemented Interfaces:

ToCopyableBuilder<PendingTasksRequest.Builder,PendingTasksRequest>

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

Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.

Nested Class Summary

Nested Classes

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

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 final Endpoint<PendingTasksRequest,PendingTasksResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.pending_tasks".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PendingTasksRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Boolean	local()	When true, the request retrieves information from the local node only.
final Time	masterTimeout()	Deprecated.
static PendingTasksRequest	of(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)
PendingTasksRequest.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._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<PendingTasksRequest,PendingTasksResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.pending_tasks".

Method Details

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

local

@Nullable
public final Boolean local()

When true, the request retrieves information from the local node only. When false, information is retrieved from the cluster manager node.

API name: local

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

toBuilder

@Nonnull
public PendingTasksRequest.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<PendingTasksRequest.Builder,PendingTasksRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PendingTasksRequest.Builder builder()

applyQueryParameters

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

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object