TimeoutConfiguration (AWS SDK for Java - OpenSdk Runtime 1.11.833 API)

java.lang.Object
- com.amazonaws.opensdk.config.TimeoutConfiguration

```
public class TimeoutConfiguration
extends Object
```
Configuration options to customize the various timeouts used by the client.

Constructor Summary

Constructors
Constructor and Description

TimeoutConfiguration()

Constructors
Constructor and Description
`TimeoutConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TimeoutConfiguration`	`connectionTimeout(Integer connectionTimeout)` Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
`Optional<Integer>`	`getConnectionTimeout()` Returns the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
`Optional<Integer>`	`getHttpRequestTimeout()` Returns the amount of time to wait (in milliseconds) for a HTTP request to complete before giving up and timing out.
`Optional<Integer>`	`getSocketTimeout()` Returns the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
`Optional<Integer>`	`getTotalExecutionTimeout()` Returns the amount of time (in milliseconds) to allow the client to complete the execution of an API call.
`TimeoutConfiguration`	`httpRequestTimeout(Integer httpRequestTimeout)` Sets the amount of time to wait (in milliseconds) for a single HTTP request to complete before giving up and timing out.
`void`	`setConnectionTimeout(Integer connectionTimeout)` Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
`void`	`setHttpRequestTimeout(Integer httpRequestTimeout)` Sets the amount of time to wait (in milliseconds) for a single HTTP request to complete before giving up and timing out.
`void`	`setSocketTimeout(Integer socketTimeout)` Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
`void`	`setTotalExecutionTimeout(Integer totalExecutionTimeout)` Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call.
`TimeoutConfiguration`	`socketTimeout(Integer socketTimeout)` Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
`TimeoutConfiguration`	`totalExecutionTimeout(Integer totalExecutionTimeout)` Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TimeoutConfiguration
```
public TimeoutConfiguration()
```
- Method Detail
  - getSocketTimeout
```
public Optional<Integer> getSocketTimeout()
```
    Returns the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed. A value of 0 means infinity, and isn't recommended.
    Default value is .
    
    Returns:
    
    The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
  - setSocketTimeout
```
public void setSocketTimeout(Integer socketTimeout)
```
    Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
    Default value is .
    
    Parameters:
    
    socketTimeout - The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is times out and is closed.
  - socketTimeout
```
public TimeoutConfiguration socketTimeout(Integer socketTimeout)
```
    Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
    Default value is .
    
    Parameters:
    
    socketTimeout - The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection is times out and is closed.
    
    Returns:
    
    This object for method chaining.
  - getConnectionTimeout
```
public Optional<Integer> getConnectionTimeout()
```
    Returns the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out. A value of 0 means infinity, and is not recommended.
    Default value is 10000.
    
    Returns:
    
    The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
  - setConnectionTimeout
```
public void setConnectionTimeout(Integer connectionTimeout)
```
    Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
    Default value is 10000.
    
    Parameters:
    
    connectionTimeout - The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
  - connectionTimeout
```
public TimeoutConfiguration connectionTimeout(Integer connectionTimeout)
```
    Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
    Default value is 10000.
    
    Parameters:
    
    connectionTimeout - The amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
    
    Returns:
    
    This object for method chaining.
  - getHttpRequestTimeout
```
public Optional<Integer> getHttpRequestTimeout()
```
    Returns the amount of time to wait (in milliseconds) for a HTTP request to complete before giving up and timing out.
    This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.
    
    The http request timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, this feature should not be used when absolute precision is needed.
    
    Default value is 0, which indicates the feature is disabled.
    
    Returns:
    
    The amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.
  - setHttpRequestTimeout
```
public void setHttpRequestTimeout(Integer httpRequestTimeout)
```
    Sets the amount of time to wait (in milliseconds) for a single HTTP request to complete before giving up and timing out.
    This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.
    
    The http request timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, this feature should not be used when absolute precision is needed.
    
    This timeout is disabled by default.
    
    Parameters:
    
    httpRequestTimeout - The amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.
  - httpRequestTimeout
```
public TimeoutConfiguration httpRequestTimeout(Integer httpRequestTimeout)
```
    Sets the amount of time to wait (in milliseconds) for a single HTTP request to complete before giving up and timing out.
    This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.
    
    The http request timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, this feature should not be used when absolute precision is needed.
    
    This timeout is disabled by default.
    
    Parameters:
    
    httpRequestTimeout - The amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.
    
    Returns:
    
    This object for method chaining.
  - getTotalExecutionTimeout
```
public Optional<Integer> getTotalExecutionTimeout()
```
    Returns the amount of time (in milliseconds) to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes all HTTP requests (even retries), unmarshalling, etc.
    This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.
    
    The total execution timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, the client execution timeout feature should not be used when absolute precision is needed.
    
    This timeout is disabled by default.
    
    Returns:
    
    The amount of time (in milliseconds) to allow the client to complete the execution of an API call.
  - setTotalExecutionTimeout
```
public void setTotalExecutionTimeout(Integer totalExecutionTimeout)
```
    Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes all HTTP requests (even retries), unmarshalling, etc.
    This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.
    
    The total execution timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, the client execution timeout feature should not be used when absolute precision is needed.
    
    This timeout is disabled by default.
    
    Parameters:
    
    totalExecutionTimeout - The amount of time (in milliseconds) to allow the client to complete the execution of an API call.
  - totalExecutionTimeout
```
public TimeoutConfiguration totalExecutionTimeout(Integer totalExecutionTimeout)
```
    Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes all HTTP requests (even retries), unmarshalling, etc.
    This feature requires buffering the entire response (for non-streaming APIs) into memory to enforce a hard timeout when reading the response. For APIs that return large responses this could be expensive.
    
    The total execution timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, the client execution timeout feature should not be used when absolute precision is needed.
    
    This timeout is disabled by default.
    
    Parameters:
    
    totalExecutionTimeout - The amount of time (in milliseconds) to allow the client to complete the execution of an API call.
    
    Returns:
    
    This object for method chaining.

Class TimeoutConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimeoutConfiguration

Method Detail

getSocketTimeout

setSocketTimeout

socketTimeout

getConnectionTimeout

setConnectionTimeout

connectionTimeout

getHttpRequestTimeout

setHttpRequestTimeout

httpRequestTimeout

getTotalExecutionTimeout

setTotalExecutionTimeout

totalExecutionTimeout