Type Parameters:

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

All Known Subinterfaces:

Request<T>, SignableRequest<T>

All Known Implementing Classes:

DefaultRequest

public interface ImmutableRequest<T>

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  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.
  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.
  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.
  int	getTimeOffset () Returns 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.

  • getContentUnwrapped

    InputStream getContentUnwrapped()

    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.

    Returns:

    The optional raw stream containing the payload data to include for this request, with all progress stream wrappers removed.

  • getReadLimitInfo

    ReadLimitInfo getReadLimitInfo()

    Returns the read limit info about the original request.

  • getOriginalRequestObject

    Object getOriginalRequestObject()

    Returns the original, user facing request object which this internal request object is representing.

    Returns:

    an instance of request as an Object.