T
- The type of original, user facing request represented by this
request.public interface Request<T>
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 |
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.
|
Map<String,String> getHeaders()
String getResourcePath()
Map<String,List<String>> getParameters()
URI getEndpoint()
HttpMethodName getHttpMethod()
int getTimeOffset()
InputStream getContent()
T getOriginalRequest()
void addHeader(String name, String value)
name
- The name of the header to set.value
- The header's value.void addParameter(String name, String value)
name
- The name of the request parameter.value
- The value of the request parameter.void setContent(InputStream content)
content
- The optional stream containing the payload data to include for
this request.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()
SdkServiceException#serviceName()
void setTimeOffset(int timeOffset)
timeOffset
- The optional value for time offset (in seconds) for this request.Request<T> withTimeOffset(int timeOffset)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.