EmptyHttpRequest (AWS SDK for Java - Bundle 1.11.385 API)

java.lang.Object
- com.amazonaws.http.request.EmptyHttpRequest

All Implemented Interfaces:

HandlerContextAware, ImmutableRequest<Object>, Request<Object>, SignableRequest<Object>
```
public class EmptyHttpRequest
extends Object
implements Request<Object>
```

Constructor Summary

Constructors
Constructor and Description
`EmptyHttpRequest(String endpoint, HttpMethodName httpMethod)`
`EmptyHttpRequest(String endpoint, HttpMethodName httpMethod, InputStream payload)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<X> void`	`addHandlerContext(HandlerContextKey<X> key, X value)` Adds a context to that is visible to all `RequestHandler2`s.
`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.
`AWSRequestMetrics`	`getAWSRequestMetrics()` Returns the request metrics.
`InputStream`	`getContent()` Returns the optional stream containing the payload data to include for this request.
`InputStream`	`getContentUnwrapped()` Returns the optional raw stream containing the payload data to include for this request, with all progress stream wrappers.
`URI`	`getEndpoint()` Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
`<X> X`	`getHandlerContext(HandlerContextKey<X> key)` Return the context for the given key if present; else return null.
`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.
`AmazonWebServiceRequest`	`getOriginalRequest()` Returns the original, user facing request object which this internal request object is representing.
`Object`	`getOriginalRequestObject()` Returns the original, user facing request object which this internal request object is representing.
`Map<String,List<String>>`	`getParameters()` Returns a map of all parameters in this request.
`ReadLimitInfo`	`getReadLimitInfo()` Returns the read limit info about the original 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`	`setAWSRequestMetrics(AWSRequestMetrics metrics)` Bind the request metrics to the 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`	`setOriginalRequest(AmazonWebServiceRequest originalRequest)`
`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<Object>`	`withParameter(String name, String value)` Adds the specified request parameter to this request, and returns the updated request object.
`Request<Object>`	`withTimeOffset(int timeOffset)` Sets the optional value for time offset for this request.

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

- Constructor Detail
  - EmptyHttpRequest
```
public EmptyHttpRequest(String endpoint,
                        HttpMethodName httpMethod)
```
  - EmptyHttpRequest
```
public EmptyHttpRequest(String endpoint,
                        HttpMethodName httpMethod,
                        InputStream payload)
```
- Method Detail
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Description copied from interface: SignableRequest
    
    Sets the specified header for this request.
    
    Specified by:
    
    addHeader in interface SignableRequest<Object>
    
    Parameters:
    
    name - The name of the header to set.
    
    value - The header's value.
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Description copied from interface: ImmutableRequest
    
    Returns a map of all the headers included in this request.
    
    Specified by:
    
    getHeaders in interface ImmutableRequest<Object>
    
    Returns:
    
    A map of all the headers included in this request.
  - setHeaders
```
public void setHeaders(Map<String,String> headers)
```
    Description copied from interface: Request
    
    Sets all headers, clearing any existing ones.
    
    Specified by:
    
    setHeaders in interface Request<Object>
  - setResourcePath
```
public void setResourcePath(String path)
```
    Description copied from interface: Request
    
    Sets the path to the resource being requested.
    
    Specified by:
    
    setResourcePath in interface Request<Object>
    
    Parameters:
    
    path - The path to the resource being requested.
  - getResourcePath
```
public String getResourcePath()
```
    Description copied from interface: ImmutableRequest
    
    Returns the path to the resource being requested.
    
    Specified by:
    
    getResourcePath in interface ImmutableRequest<Object>
    
    Returns:
    
    The path to the resource being requested.
  - addParameter
```
public void addParameter(String name,
                         String value)
```
    Description copied from interface: SignableRequest
    
    Adds the specified request parameter to this request.
    
    Specified by:
    
    addParameter in interface SignableRequest<Object>
    
    Parameters:
    
    name - The name of the request parameter.
    
    value - The value of the request parameter.
  - withParameter
```
public Request<Object> withParameter(String name,
                                     String value)
```
    Description copied from interface: Request
    
    Adds the specified request parameter to this request, and returns the updated request object.
    
    Specified by:
    
    withParameter in interface Request<Object>
    
    Parameters:
    
    name - The name of the request parameter.
    
    value - The value of the request parameter.
    
    Returns:
    
    The updated request object.
  - addParameters
```
public void addParameters(String name,
                          List<String> values)
```
    Description copied from interface: Request
    
    Adds the specified request parameter and list of values to this request.
    
    Specified by:
    
    addParameters in interface Request<Object>
    
    Parameters:
    
    name - The name of the request parameter.
    
    values - The value of the request parameter.
  - getParameters
```
public Map<String,List<String>> getParameters()
```
    Description copied from interface: ImmutableRequest
    
    Returns a map of all parameters in this request.
    
    Specified by:
    
    getParameters in interface ImmutableRequest<Object>
    
    Returns:
    
    A map of all parameters in this request.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    Description copied from interface: Request
    
    Sets all parameters, clearing any existing values. Note that List values within the parameters Map must use an implementation that supports null values.
    
    Specified by:
    
    setParameters in interface Request<Object>
  - getEndpoint
```
public URI getEndpoint()
```
    Description copied from interface: ImmutableRequest
    
    Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
    
    Specified by:
    
    getEndpoint in interface ImmutableRequest<Object>
    
    Returns:
    
    The service endpoint to which this request should be sent.
  - setEndpoint
```
public void setEndpoint(URI endpoint)
```
    Description copied from interface: Request
    
    Sets the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
    
    Specified by:
    
    setEndpoint in interface Request<Object>
    
    Parameters:
    
    endpoint - The service endpoint to which this request should be sent.
  - getHttpMethod
```
public HttpMethodName getHttpMethod()
```
    Description copied from interface: ImmutableRequest
    
    Returns the HTTP method (GET, POST, etc) to use when sending this request.
    
    Specified by:
    
    getHttpMethod in interface ImmutableRequest<Object>
    
    Returns:
    
    The HTTP method to use when sending this request.
  - setHttpMethod
```
public void setHttpMethod(HttpMethodName httpMethod)
```
    Description copied from interface: Request
    
    Sets the HTTP method (GET, POST, etc) to use when sending this request.
    
    Specified by:
    
    setHttpMethod in interface Request<Object>
    
    Parameters:
    
    httpMethod - The HTTP method to use when sending this request.
  - getContent
```
public InputStream getContent()
```
    Description copied from interface: ImmutableRequest
    
    Returns the optional stream containing the payload data to include for this request. Not all requests will contain payload data.
    
    Specified by:
    
    getContent in interface ImmutableRequest<Object>
    
    Returns:
    
    The optional stream containing the payload data to include for this request.
  - setContent
```
public void setContent(InputStream content)
```
    Description copied from interface: SignableRequest
    
    Sets the optional stream containing the payload data to include for this request. This is used, for example, for S3 chunk encoding.
    
    Specified by:
    
    setContent in interface SignableRequest<Object>
    
    Parameters:
    
    content - The optional stream containing the payload data to include for this request.
  - getServiceName
```
public String getServiceName()
```
    Specified by:
    
    getServiceName in interface Request<Object>
    
    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. This is NOT the same as the service name returned by AmazonWebServiceClient.getServiceName() which is used for signing purpose.
    
    See Also:
    
    AmazonServiceException#getServiceName()}, AWSRequestMetrics.Field#ServiceName}
  - getOriginalRequest
```
public AmazonWebServiceRequest getOriginalRequest()
```
    Description copied from interface: Request
    
    Returns the original, user facing request object which this internal request object is representing.
    
    Specified by:
    
    getOriginalRequest in interface Request<Object>
  - setOriginalRequest
```
public void setOriginalRequest(AmazonWebServiceRequest originalRequest)
```
  - getTimeOffset
```
public int getTimeOffset()
```
    Description copied from interface: ImmutableRequest
    
    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.
    
    Specified by:
    
    getTimeOffset in interface ImmutableRequest<Object>
    
    Returns:
    
    The optional value for time offset (in seconds) for this request.
  - setTimeOffset
```
public void setTimeOffset(int timeOffset)
```
    Description copied from interface: Request
    
    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.
    
    Specified by:
    
    setTimeOffset in interface Request<Object>
    
    Parameters:
    
    timeOffset - The optional value for time offset (in seconds) for this request.
  - withTimeOffset
```
public Request<Object> withTimeOffset(int timeOffset)
```
    Description copied from interface: Request
    
    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.
    
    Specified by:
    
    withTimeOffset in interface Request<Object>
    
    Returns:
    
    The updated request object.
  - getAWSRequestMetrics
```
public AWSRequestMetrics getAWSRequestMetrics()
```
    Description copied from interface: Request
    
    Returns the request metrics.
    
    Specified by:
    
    getAWSRequestMetrics in interface Request<Object>
  - setAWSRequestMetrics
```
public void setAWSRequestMetrics(AWSRequestMetrics metrics)
```
    Description copied from interface: Request
    
    Bind the request metrics to the request. Note metrics can be captured before the request is created.
    
    Specified by:
    
    setAWSRequestMetrics in interface Request<Object>
  - getReadLimitInfo
```
public ReadLimitInfo getReadLimitInfo()
```
    Description copied from interface: ImmutableRequest
    
    Returns the read limit info about the original request.
    
    Specified by:
    
    getReadLimitInfo in interface ImmutableRequest<Object>
  - getContentUnwrapped
```
public InputStream getContentUnwrapped()
```
    Description copied from interface: ImmutableRequest
    
    Returns the optional raw stream containing the payload data to include for this request, with all progress stream wrappers. Not all requests contain payload data.
    
    Specified by:
    
    getContentUnwrapped in interface ImmutableRequest<Object>
    
    Returns:
    
    The optional raw stream containing the payload data to include for this request, with all progress stream wrappers removed.
  - getOriginalRequestObject
```
public Object getOriginalRequestObject()
```
    Description copied from interface: ImmutableRequest
    
    Returns the original, user facing request object which this internal request object is representing.
    
    Specified by:
    
    getOriginalRequestObject in interface ImmutableRequest<Object>
    
    Returns:
    
    an instance of request as an Object.
  - addHandlerContext
```
public <X> void addHandlerContext(HandlerContextKey<X> key,
                                  X value)
```
    Description copied from interface: HandlerContextAware
    
    Adds a context to that is visible to all RequestHandler2s. Note that, context added here will available only for the scope of the request execution and will not be marshalled over the wire.
    
    Specified by:
    
    addHandlerContext in interface HandlerContextAware
    
    Parameters:
    
    key - the key for the property being set in the request.
    
    value - the value for the property being set in the request.
  - getHandlerContext
```
public <X> X getHandlerContext(HandlerContextKey<X> key)
```
    Description copied from interface: HandlerContextAware
    
    Return the context for the given key if present; else return null.
    
    Specified by:
    
    getHandlerContext in interface HandlerContextAware
    
    Parameters:
    
    key - the key for the context
    
    Returns:
    
    the context if present else null.

Class EmptyHttpRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EmptyHttpRequest

EmptyHttpRequest

Method Detail

addHeader

getHeaders

setHeaders

setResourcePath

getResourcePath

addParameter

withParameter

addParameters

getParameters

setParameters

getEndpoint

setEndpoint

getHttpMethod

setHttpMethod

getContent

setContent

getServiceName

getOriginalRequest

setOriginalRequest

getTimeOffset

setTimeOffset

withTimeOffset

getAWSRequestMetrics

setAWSRequestMetrics

getReadLimitInfo

getContentUnwrapped

getOriginalRequestObject

addHandlerContext

getHandlerContext