T
- The type of original, user facing request represented by this
request.public interface Request<T> extends SignableRequest<T>, HandlerContextAware
This class is only intended for use inside the AWS client libraries and request handlers. Users of the AWS SDK for Java should not implement this interface.
Modifier and Type | Method and Description |
---|---|
void |
addParameters(String name,
List<String> values)
Adds the specified request parameter and list of values to this request.
|
AWSRequestMetrics |
getAWSRequestMetrics()
Returns the request metrics.
|
AmazonWebServiceRequest |
getOriginalRequest()
Returns the original, user facing request object which this internal
request object is representing.
|
String |
getServiceName() |
void |
setAWSRequestMetrics(AWSRequestMetrics metrics)
Bind the request metrics to the request.
|
void |
setEndpoint(URI endpoint)
Sets the service endpoint (ex: "https://ec2.amazonaws.com") to which this
request should be sent.
|
void |
setHeaders(Map<String,String> headers)
Sets all headers, clearing any existing ones.
|
void |
setHttpMethod(HttpMethodName httpMethod)
Sets the HTTP method (GET, POST, etc) to use when sending this request.
|
void |
setParameters(Map<String,List<String>> parameters)
Sets all parameters, clearing any existing values.
|
void |
setResourcePath(String path)
Sets the path to the resource being requested.
|
void |
setTimeOffset(int timeOffset)
Sets the optional value for time offset for this request.
|
Request<T> |
withParameter(String name,
String value)
Adds the specified request parameter to this request, and returns the
updated request object.
|
Request<T> |
withTimeOffset(int timeOffset)
Sets the optional value for time offset for this request.
|
addHeader, addParameter, setContent
getContent, getContentUnwrapped, getEndpoint, getHeaders, getHttpMethod, getOriginalRequestObject, getParameters, getReadLimitInfo, getResourcePath, getTimeOffset
addHandlerContext, getHandlerContext
void setHeaders(Map<String,String> headers)
void setResourcePath(String path)
path
- The path to the resource being requested.Request<T> withParameter(String name, String value)
name
- The name of the request parameter.value
- The value of the request parameter.void setParameters(Map<String,List<String>> parameters)
void addParameters(String name, List<String> values)
name
- The name of the request parameter.values
- The value of the request parameter.void setEndpoint(URI endpoint)
endpoint
- The service endpoint to which this request should be sent.void setHttpMethod(HttpMethodName httpMethod)
httpMethod
- The HTTP method to use when sending this request.String getServiceName()
AmazonWebServiceClient.getServiceName()
which is used for
signing purpose.AmazonServiceException#getServiceName()}
,
AWSRequestMetrics.Field#ServiceName}
AmazonWebServiceRequest getOriginalRequest()
void setTimeOffset(int timeOffset)
timeOffset
- The optional value for time offset (in seconds) for this request.Request<T> withTimeOffset(int timeOffset)
AWSRequestMetrics getAWSRequestMetrics()
void setAWSRequestMetrics(AWSRequestMetrics metrics)
IllegalStateException
- if the binding has already occurred