Request (AWS Java SDK :: SDK Core 2.0.0 API)

Type Parameters:

T - The type of original, user facing request represented by this request.

All Known Implementing Classes:

DefaultRequest
```
public interface Request<T>
```
Represents a request being sent to an Amazon Web Service, including the parameters being sent as part of the request, the endpoint to which the request should be sent, etc.
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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addHeader(String name, String value)` Sets the specified header for this request.
`void`	`addParameter(String name, String value)` Adds the specified request parameter to this request.
`void`	`addParameters(String name, List<String> values)` Adds the specified request parameter and list of values to this request.
`InputStream`	`getContent()` Returns the optional stream containing the payload data to include for this request.
`URI`	`getEndpoint()` Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
`Map<String,String>`	`getHeaders()` Returns a map of all the headers included in this request.
`HttpMethodName`	`getHttpMethod()` Returns the HTTP method (GET, POST, etc) to use when sending this request.
`T`	`getOriginalRequest()` request object is representing.
`Map<String,List<String>>`	`getParameters()` Returns a map of all parameters in this request.
`String`	`getResourcePath()` Returns the path to the resource being requested.
`String`	`getServiceName()`
`int`	`getTimeOffset()` Returns the optional value for time offset for this request.
`void`	`setContent(InputStream content)` Sets the optional stream containing the payload data to include for this 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.

- Method Detail
  - getHeaders
```
Map<String,String> getHeaders()
```
    Returns a map of all the headers included in this request.
    
    Returns:
    
    A map of all the headers included in this request.
  - getResourcePath
```
String getResourcePath()
```
    Returns the path to the resource being requested.
    
    Returns:
    
    The path to the resource being requested.
  - getParameters
```
Map<String,List<String>> getParameters()
```
    Returns a map of all parameters in this request.
    
    Returns:
    
    A map of all parameters in this request.
  - getEndpoint
```
URI getEndpoint()
```
    Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
    
    Returns:
    
    The service endpoint to which this request should be sent.
  - getHttpMethod
```
HttpMethodName getHttpMethod()
```
    Returns the HTTP method (GET, POST, etc) to use when sending this request.
    
    Returns:
    
    The HTTP method to use when sending this request.
  - getTimeOffset
```
int getTimeOffset()
```
    Returns the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    Returns:
    
    The optional value for time offset (in seconds) for this request.
  - getContent
```
InputStream getContent()
```
    Returns the optional stream containing the payload data to include for this request. Not all requests will contain payload data.
    
    Returns:
    
    The optional stream containing the payload data to include for this request.
  - getOriginalRequest
```
T getOriginalRequest()
```
    request object is representing.
  - addHeader
```
void addHeader(String name,
               String value)
```
    Sets the specified header for this request.
    
    Parameters:
    
    name - The name of the header to set.
    
    value - The header's value.
  - addParameter
```
void addParameter(String name,
                  String value)
```
    Adds the specified request parameter to this request.
    
    Parameters:
    
    name - The name of the request parameter.
    
    value - The value of the request parameter.
  - setContent
```
void setContent(InputStream content)
```
    Sets the optional stream containing the payload data to include for this request. This is used, for example, for S3 chunk encoding.
    
    Parameters:
    
    content - The optional stream containing the payload data to include for this request.
  - setHeaders
```
void setHeaders(Map<String,String> headers)
```
    Sets all headers, clearing any existing ones.
  - setResourcePath
```
void setResourcePath(String path)
```
    Sets the path to the resource being requested.
    
    Parameters:
    
    path - The path to the resource being requested.
  - withParameter
```
Request<T> withParameter(String name,
                         String value)
```
    Adds the specified request parameter to this request, and returns the updated request object.
    
    Parameters:
    
    name - The name of the request parameter.
    
    value - The value of the request parameter.
    
    Returns:
    
    The updated request object.
  - setParameters
```
void setParameters(Map<String,List<String>> parameters)
```
    Sets all parameters, clearing any existing values. Note that List values within the parameters Map must use an implementation that supports null values.
  - addParameters
```
void addParameters(String name,
                   List<String> values)
```
    Adds the specified request parameter and list of values to this request.
    
    Parameters:
    
    name - The name of the request parameter.
    
    values - The value of the request parameter.
  - setEndpoint
```
void setEndpoint(URI endpoint)
```
    Sets the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
    
    Parameters:
    
    endpoint - The service endpoint to which this request should be sent.
  - setHttpMethod
```
void setHttpMethod(HttpMethodName httpMethod)
```
    Sets the HTTP method (GET, POST, etc) to use when sending this request.
    
    Parameters:
    
    httpMethod - The HTTP method to use when sending this request.
  - getServiceName
```
String getServiceName()
```
    Returns:
    
    The name of the Amazon service this request is for. This is used as the service name set in request metrics and service exceptions.
    
    See Also:
    
    SdkServiceException#serviceName()
  - setTimeOffset
```
void setTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    Parameters:
    
    timeOffset - The optional value for time offset (in seconds) for this request.
  - withTimeOffset
```
Request<T> withTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    Returns:
    
    The updated request object.

Interface Request<T>

Method Summary

Method Detail

getHeaders

getResourcePath

getParameters

getEndpoint

getHttpMethod

getTimeOffset

getContent

getOriginalRequest

addHeader

addParameter

setContent

setHeaders

setResourcePath

withParameter

setParameters

addParameters

setEndpoint

setHttpMethod

getServiceName

setTimeOffset

withTimeOffset