TimedRequest (rest-high-level 6.7.2 API)

java.lang.Object
- org.elasticsearch.client.TimedRequest

All Implemented Interfaces:

Validatable

Direct Known Subclasses:

CreateIndexRequest, DeleteLicenseRequest, DeleteLifecyclePolicyRequest, ExplainLifecycleRequest, FreezeIndexRequest, GetIndexRequest, GetLifecyclePolicyRequest, GetMappingsRequest, IndexUpgradeInfoRequest, LifecycleManagementStatusRequest, PutLicenseRequest, PutLifecyclePolicyRequest, PutMappingRequest, RemoveIndexLifecyclePolicyRequest, RetryLifecyclePolicyRequest, RolloverRequest, StartBasicRequest, StartILMRequest, StopILMRequest, UnfreezeIndexRequest, XPackUsageRequest
```
public abstract class TimedRequest
extends java.lang.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 TimeValue DEFAULT_ACK_TIMEOUT

static TimeValue DEFAULT_MASTER_NODE_TIMEOUT
- Fields inherited from interface org.elasticsearch.client.Validatable
  EMPTY

Constructor Summary

Constructors
Constructor Description

TimedRequest()

Method Summary

Modifier and Type	Method	Description
`TimeValue`	`masterNodeTimeout()`	Returns the timeout for the request to be completed on the master node
`void`	`setMasterTimeout(TimeValue masterTimeout)`	Sets the timeout to connect to the master node
`void`	`setTimeout(TimeValue timeout)`	Sets the timeout to wait for the all the nodes to acknowledge
`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.elasticsearch.client.Validatable
validate

- Field Detail
  - DEFAULT_ACK_TIMEOUT
```
public static final TimeValue DEFAULT_ACK_TIMEOUT
```
  - DEFAULT_MASTER_NODE_TIMEOUT
```
public static final TimeValue DEFAULT_MASTER_NODE_TIMEOUT
```
- Constructor Detail
  - TimedRequest
```
public TimedRequest()
```
- Method Detail
  - setTimeout
```
public void setTimeout(TimeValue timeout)
```
    Sets the timeout to wait for the all the nodes to acknowledge
    
    Parameters:
    
    timeout - timeout as a TimeValue
  - setMasterTimeout
```
public void setMasterTimeout(TimeValue masterTimeout)
```
    Sets the timeout to connect to the master node
    
    Parameters:
    
    masterTimeout - timeout as a TimeValue
  - timeout
```
public TimeValue timeout()
```
    Returns the request timeout
  - masterNodeTimeout
```
public TimeValue masterNodeTimeout()
```
    Returns the timeout for the request to be completed on the master node