com.amazonaws.mobileconnectors.apigateway

Class ApiRequest

java.lang.Object

com.amazonaws.mobileconnectors.apigateway.ApiRequest

public class ApiRequest
extends Object

Represents a request being sent to Amazon Api Gateway, including the parameters being sent as part of the request, the endpoint to which the request should be sent, etc.

Constructor Summary

Constructors

Constructor and Description
ApiRequest() Constructor.
ApiRequest(String serviceName) Constructor.

Method Summary

Modifier and Type	Method and Description
ApiRequest	addHeader(String header, String value) Sets the header in the request.
Map<String,String>	getHeaders() Returns a map of all the headers included in this request.
HttpMethodName	getHttpMethod()
Map<String,String>	getParameters() Returns a map of all parameters in this request.
String	getPath() Returns the path to the resource being requested.
ApiRequest	withBody(byte[] body) Sets the optional stream containing the payload data from the byte array to include for this request.
ApiRequest	withBody(InputStream body) Sets the optional stream containing the payload data to include for this request.
ApiRequest	withBody(String body) Sets the optional stream containing the payload data from a string content to include for this request.
ApiRequest	withHeaders(Map<String,String> headers) Sets all headers, clearing any existing ones.
ApiRequest	withHttpMethod(HttpMethodName httpMethod) Sets the HTTP method (GET, POST, etc) to use when sending this request.
ApiRequest	withParameter(String name, String value) Set parameters with name and value.
ApiRequest	withParameters(Map<String,String> parameters) Sets all parameters, clearing any existing values.
ApiRequest	withPath(String path) Sets the path to the resource being requested.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiRequest

public ApiRequest(String serviceName)

Constructor.

Parameters:

serviceName - The name of the service to which this request is being sent.

ApiRequest

public ApiRequest()

Constructor.

Method Detail

withHeaders

public ApiRequest withHeaders(Map<String,String> headers)

Sets all headers, clearing any existing ones.

Parameters:

headers - A map of all http headers

Returns:

the updated request object.

addHeader

public ApiRequest addHeader(String header,
                            String value)

Sets the header in the request.

Parameters:

header - the http header name.

value - the http header value.

Returns:

the updated request object.

getHeaders

public 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.

withPath

public ApiRequest withPath(String path)

Sets the path to the resource being requested.

Parameters:

path - The path to the resource being requested.

Returns:

the updated request object.

getPath

public String getPath()

Returns the path to the resource being requested.

Returns:

The path to the resource being requested.

withParameters

public ApiRequest withParameters(Map<String,String> parameters)

Sets all parameters, clearing any existing values.

Parameters:

parameters - the http request parameters.

Returns:

the updated request object.

getParameters

public Map<String,String> getParameters()

Returns a map of all parameters in this request.

Returns:

A map of all parameters in this request.

withParameter

public ApiRequest withParameter(String name,
                                String value)

Set parameters with name and value.

Parameters:

name - the parameter name.

value - the parameter value.

Returns:

the updated request object.

withHttpMethod

public ApiRequest withHttpMethod(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.

Returns:

the updated request object.

getHttpMethod

public HttpMethodName getHttpMethod()

Returns:

the HttpMethodName

withBody

public ApiRequest withBody(InputStream body)

Sets the optional stream containing the payload data to include for this request. Not all requests will contain payload data.

Parameters:

body - The optional stream containing the payload data to include for this request.

Returns:

the updated request object.

withBody

public ApiRequest withBody(byte[] body)

Sets the optional stream containing the payload data from the byte array to include for this request. Not all requests will contain payload data.

Parameters:

body - The request body represented as a array of bytes.

Returns:

the updated request object.

withBody

public ApiRequest withBody(String body)

Sets the optional stream containing the payload data from a string content to include for this request. Not all requests will contain payload data.

Parameters:

body - the request body represented as a string.

Returns:

the updated request object.