Package software.amazon.awssdk

Class RequestConfig

java.lang.Object

software.amazon.awssdk.RequestConfig

Direct Known Subclasses:

AmazonWebServiceRequestAdapter

public abstract class RequestConfig
extends Object

Generic representation of request level configuration. The customer interface for specifying request level configuration is a base request class with configuration methods.

Field Summary

Fields

Modifier and Type	Field	Description
static RequestConfig	NO_OP	No op implementation to initalize request config in DefaultRequest.

Constructor Summary

Constructors

Constructor	Description
RequestConfig()

Method Summary

Modifier and Type	Method	Description
abstract Integer	getClientExecutionTimeout()
abstract AwsCredentialsProvider	getCredentialsProvider()
abstract Map<String,List<String>>	getCustomQueryParameters()
abstract Map<String,String>	getCustomRequestHeaders()
abstract Object	getOriginalRequest()
abstract ProgressListener	getProgressListener()
abstract RequestClientOptions	getRequestClientOptions()
abstract RequestMetricCollector	getRequestMetricsCollector()
abstract String	getRequestType()

Methods inherited from class java.lang.Object

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

Field Detail

NO_OP

public static final RequestConfig NO_OP

No op implementation to initalize request config in DefaultRequest.

Constructor Detail

RequestConfig

public RequestConfig()

Method Detail

getProgressListener

public abstract ProgressListener getProgressListener()

getRequestMetricsCollector

public abstract RequestMetricCollector getRequestMetricsCollector()

getCredentialsProvider

public abstract AwsCredentialsProvider getCredentialsProvider()

getCustomRequestHeaders

public abstract Map<String,String> getCustomRequestHeaders()

Returns:

A non null map of custom headers to inject into the request.

getCustomQueryParameters

public abstract Map<String,List<String>> getCustomQueryParameters()

Returns:

A non null map of custom query parameters to inject into the request.

getClientExecutionTimeout

public abstract Integer getClientExecutionTimeout()

getRequestClientOptions

public abstract RequestClientOptions getRequestClientOptions()

getRequestType

public abstract String getRequestType()

Returns:

String identifying the 'type' (i.e. operation) of the request. Used in metrics subsystem.

getOriginalRequest

public abstract Object getOriginalRequest()

Returns:

The original request object. May be delivered to various strategies or hooks for extra context. I.E. RequestHandler or RetryPolicy.