HttpRequestor::Parameters Class Reference

#include <HttpRequestParameters.h>

Public Member Functions
	Parameters (const AZStd::string &URI, Aws::Http::HttpMethod method, const Callback &callback, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
	Parameters (const AZStd::string &URI, Aws::Http::HttpMethod method, const Headers &headers, const Callback &callback, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
	Parameters (const AZStd::string &URI, Aws::Http::HttpMethod method, const Headers &headers, const AZStd::string &body, const Callback &callback, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
	Parameters (const Parameters &)=default
Parameters &	operator= (const Parameters &)=default
	Parameters (Parameters &&)=default
Parameters &	operator= (Parameters &&)=default
const Aws::String &	GetURI () const
	Get the URI in string form as an recipient of the HTTP connection.
Aws::Http::HttpMethod	GetMethod () const
	Get the HTTP method configured to use for a request.
const Headers &	GetHeaders () const
const std::shared_ptr< std::stringstream > &	GetBodyStream () const
const Callback &	GetCallback () const
const Aws::Client::ClientConfiguration &	GetClientConfiguration () const

Detailed Description

Models the parameters needed to make a HTTP call and then receive the returned JSON in a meaningful place. Examples of use are in the HttpRequestCaller class.

Constructor & Destructor Documentation

Parameters() [1/3]

HttpRequestor::Parameters::Parameters ( const AZStd::string &  URI, Aws::Http::HttpMethod  method, const Callback &  callback, const Aws::Client::ClientConfiguration &  clientConfiguration = Aws::Client::ClientConfiguration()  )

inline

Parameters

URI	A universal resource indicator representing an endpoint.
method	The HTTP method to use, for example HTTP_GET.
callback	The callback method to receive a HTTP call's response.
clientConfiguration	The client configuration to use for the HTTP request.

Parameters() [2/3]

HttpRequestor::Parameters::Parameters ( const AZStd::string &  URI, Aws::Http::HttpMethod  method, const Headers &  headers, const Callback &  callback, const Aws::Client::ClientConfiguration &  clientConfiguration = Aws::Client::ClientConfiguration()  )

inline

Parameters

URI	A universal resource indicator representing an endpoint.
method	The HTTP method to use, for example HTTP_GET.
headers	A map of header names and values to use.
callback	The callback method to receive a HTTP call's response.
clientConfiguration	The client configuration to use for the HTTP request.

Parameters() [3/3]

HttpRequestor::Parameters::Parameters ( const AZStd::string &  URI, Aws::Http::HttpMethod  method, const Headers &  headers, const AZStd::string &  body, const Callback &  callback, const Aws::Client::ClientConfiguration &  clientConfiguration = Aws::Client::ClientConfiguration()  )

inline

Parameters

URI	A universal resource indicator representing an endpoint.
method	The HTTP method to use, for example HTTP_POST.
headers	A map of header names and values to use.
body	An data to associate with an HTTP call.
callback	The callback method to receive a HTTP call's response.
clientConfiguration	The client configuration to use for the HTTP request.

Member Function Documentation

GetBodyStream()

const std::shared_ptr<std::stringstream>& HttpRequestor::Parameters::GetBodyStream ( ) const

inline

Get an input stream that can be used to send the body of a request.

Returns

A string stream representing a request body.

GetCallback()

const Callback& HttpRequestor::Parameters::GetCallback ( ) const

inline

Get the callback function for processing JSON returned in an HTTP response. Callback functions are responsible for correctly interpreting the HTTP response code, and should communicate any failures.

Returns

The callback function to process endpoint responses with.

GetClientConfiguration()

const Aws::Client::ClientConfiguration& HttpRequestor::Parameters::GetClientConfiguration ( ) const

inline

Get the client configuration to use for the HTTP request.

Returns

The client configuration to use for the HTTP request.

GetHeaders()

const Headers& HttpRequestor::Parameters::GetHeaders ( ) const

inline

Get the list of extra headers to send as part of a request.

Returns

A map of header-value pairs.

---

The documentation for this class was generated from the following file:

• Gems/HttpRequestor/Code/Include/HttpRequestor/HttpRequestParameters.h