Package org.opensearch.client

Class TimedRequest

java.lang.Object

org.opensearch.client.TimedRequest

All Implemented Interfaces:

Validatable

Direct Known Subclasses:

CloseIndexRequest, CreateIndexRequest, DeleteAliasRequest, DeleteComponentTemplateRequest, DeleteComposableIndexTemplateRequest, DeleteSnapshotLifecyclePolicyRequest, ExecuteSnapshotLifecyclePolicyRequest, ExecuteSnapshotLifecycleRetentionRequest, GetIndexRequest, GetMappingsRequest, GetSnapshotLifecyclePolicyRequest, GetSnapshotLifecycleStatsRequest, PutComponentTemplateRequest, PutComposableIndexTemplateRequest, PutMappingRequest, PutSnapshotLifecyclePolicyRequest, ResizeRequest, RolloverRequest, SimulateIndexTemplateRequest, SnapshotLifecycleManagementStatusRequest, StartSLMRequest, StopSLMRequest

public abstract class TimedRequest
extends Object
implements Validatable

A base request for any requests that supply timeouts. Please note, any requests that use a ackTimeout should set timeout as they represent the same backing field on the server.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.opensearch.common.unit.TimeValue	DEFAULT_ACK_TIMEOUT
static final org.opensearch.common.unit.TimeValue	DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT
static final org.opensearch.common.unit.TimeValue	DEFAULT_MASTER_NODE_TIMEOUT	Deprecated. As of 2.2, because supporting inclusive language, replaced by DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT

Fields inherited from interface org.opensearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
TimedRequest()

Method Summary

Modifier and Type	Method	Description
org.opensearch.common.unit.TimeValue	clusterManagerNodeTimeout()	Returns the timeout for the request to be completed on the cluster-manager node
org.opensearch.common.unit.TimeValue	masterNodeTimeout()	Deprecated. As of 2.2, because supporting inclusive language, replaced by clusterManagerNodeTimeout()
void	setClusterManagerTimeout(org.opensearch.common.unit.TimeValue clusterManagerTimeout)	Sets the timeout to connect to the cluster-manager node
void	setMasterTimeout(org.opensearch.common.unit.TimeValue clusterManagerTimeout)	Deprecated. As of 2.2, because supporting inclusive language, replaced by setClusterManagerTimeout(TimeValue)
void	setTimeout(org.opensearch.common.unit.TimeValue timeout)	Sets the timeout to wait for the all the nodes to acknowledge
org.opensearch.common.unit.TimeValue	timeout()	Returns the request timeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.Validatable

validate

Field Details

DEFAULT_ACK_TIMEOUT

public static final org.opensearch.common.unit.TimeValue DEFAULT_ACK_TIMEOUT

DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT

public static final org.opensearch.common.unit.TimeValue DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT

DEFAULT_MASTER_NODE_TIMEOUT

@Deprecated
public static final org.opensearch.common.unit.TimeValue DEFAULT_MASTER_NODE_TIMEOUT

Deprecated.

As of 2.2, because supporting inclusive language, replaced by DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT

Constructor Details

TimedRequest

public TimedRequest()

Method Details

setTimeout

public void setTimeout(org.opensearch.common.unit.TimeValue timeout)

Sets the timeout to wait for the all the nodes to acknowledge

Parameters:

timeout - timeout as a TimeValue

setClusterManagerTimeout

public void setClusterManagerTimeout(org.opensearch.common.unit.TimeValue clusterManagerTimeout)

Sets the timeout to connect to the cluster-manager node

Parameters:

clusterManagerTimeout - timeout as a TimeValue

setMasterTimeout

@Deprecated
public void setMasterTimeout(org.opensearch.common.unit.TimeValue clusterManagerTimeout)

Deprecated.

As of 2.2, because supporting inclusive language, replaced by setClusterManagerTimeout(TimeValue)

Sets the timeout to connect to the cluster-manager node

Parameters:

clusterManagerTimeout - timeout as a TimeValue

timeout

public org.opensearch.common.unit.TimeValue timeout()

Returns the request timeout

clusterManagerNodeTimeout

public org.opensearch.common.unit.TimeValue clusterManagerNodeTimeout()

Returns the timeout for the request to be completed on the cluster-manager node

masterNodeTimeout

@Deprecated
public org.opensearch.common.unit.TimeValue masterNodeTimeout()

Deprecated.

As of 2.2, because supporting inclusive language, replaced by clusterManagerNodeTimeout()

Returns the timeout for the request to be completed on the cluster-manager node