Aws::AmazonWebServiceRequest Class Reference

#include <AmazonWebServiceRequest.h>

Inheritance diagram for Aws::AmazonWebServiceRequest:

Public Types

using EndpointParameters = Aws::Vector< Aws::Endpoint::EndpointParameter >

 

Public Member Functions

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual std::shared_ptr< Aws::IOStream > GetBody () const =0

 

virtual Aws::Http::HeaderValueCollection GetHeaders () const =0

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

virtual void AddQueryStringParameters (Aws::Http::URI &uri) const

 

virtual void PutToPresignedUrl (Aws::Http::URI &uri) const

 

virtual bool IsStreaming () const

 

virtual bool IsEventStreamRequest () const

 

virtual bool HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual const char * GetServiceRequestName () const =0

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Base level abstraction for all modeled AWS requests

Definition at line 46 of file AmazonWebServiceRequest.h.

Member Typedef Documentation

EndpointParameters

using Aws::AmazonWebServiceRequest::EndpointParameters = Aws::Vector<Aws::Endpoint::EndpointParameter>

Definition at line 212 of file AmazonWebServiceRequest.h.

Constructor & Destructor Documentation

AmazonWebServiceRequest()

Aws::AmazonWebServiceRequest::AmazonWebServiceRequest ( )

Sets up default response stream factory. initializes other pointers to nullptr.

~AmazonWebServiceRequest()

virtual Aws::AmazonWebServiceRequest::~AmazonWebServiceRequest ( )

virtualdefault

Member Function Documentation

AddQueryStringParameters()

virtual void Aws::AmazonWebServiceRequest::AddQueryStringParameters ( Aws::Http::URI &  uri) const

inlinevirtual

Do nothing virtual, override this to add query strings to the request

Definition at line 75 of file AmazonWebServiceRequest.h.

AddUserAgentFeature()

void Aws::AmazonWebServiceRequest::AddUserAgentFeature ( Aws::Client::UserAgentFeature  feature) const

inline

Adds a used feature to the user agent string for the request.

Parameters

feature

the feature to be added in the user agent string.

Definition at line 222 of file AmazonWebServiceRequest.h.

DumpBodyToUrl()

virtual void Aws::AmazonWebServiceRequest::DumpBodyToUrl ( Aws::Http::URI &  uri) const

inlineprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Definition at line 242 of file AmazonWebServiceRequest.h.

GetAdditionalCustomHeaders()

virtual const Aws::Http::HeaderValueCollection & Aws::AmazonWebServiceRequest::GetAdditionalCustomHeaders ( ) const

virtual

Get the additional user-set custom headers for the request

GetBody()

virtual std::shared_ptr< Aws::IOStream > Aws::AmazonWebServiceRequest::GetBody ( ) const

pure virtual

Get the payload for the request

Implemented in Aws::AmazonSerializableWebServiceRequest, and Aws::AmazonStreamingWebServiceRequest.

GetChecksumAlgorithmName()

virtual Aws::String Aws::AmazonWebServiceRequest::GetChecksumAlgorithmName ( ) const

inlinevirtual

Definition at line 204 of file AmazonWebServiceRequest.h.

GetContinueRequestHandler()

virtual const Aws::Http::ContinueRequestHandler & Aws::AmazonWebServiceRequest::GetContinueRequestHandler ( ) const

inlinevirtual

get closure for handling whether or not to cancel a request.

Definition at line 190 of file AmazonWebServiceRequest.h.

GetDataReceivedEventHandler()

virtual const Aws::Http::DataReceivedEventHandler & Aws::AmazonWebServiceRequest::GetDataReceivedEventHandler ( ) const

inlinevirtual

get closure for data received event.

Definition at line 182 of file AmazonWebServiceRequest.h.

GetDataSentEventHandler()

virtual const Aws::Http::DataSentEventHandler & Aws::AmazonWebServiceRequest::GetDataSentEventHandler ( ) const

inlinevirtual

get closure for data sent event

Definition at line 186 of file AmazonWebServiceRequest.h.

GetEndpointContextParams()

virtual EndpointParameters Aws::AmazonWebServiceRequest::GetEndpointContextParams ( ) const

virtual

GetHeaders()

virtual Aws::Http::HeaderValueCollection Aws::AmazonWebServiceRequest::GetHeaders ( ) const

pure virtual

Get the headers for the request

Implemented in Aws::AmazonStreamingWebServiceRequest.

GetHeadersReceivedEventHandler()

virtual const Aws::Http::HeadersReceivedEventHandler & Aws::AmazonWebServiceRequest::GetHeadersReceivedEventHandler ( ) const

inlinevirtual

get closure for headers received event.

Definition at line 178 of file AmazonWebServiceRequest.h.

GetRequestRetryHandler()

virtual const RequestRetryHandler & Aws::AmazonWebServiceRequest::GetRequestRetryHandler ( ) const

inlinevirtual

get closure for notification that a request is being retried

Definition at line 194 of file AmazonWebServiceRequest.h.

GetRequestSignedHandler()

virtual const RequestSignedHandler & Aws::AmazonWebServiceRequest::GetRequestSignedHandler ( ) const

inlinevirtual

Get closure for request signed event.

Definition at line 124 of file AmazonWebServiceRequest.h.

GetRequestSpecificSupportedAuth()

virtual Aws::Vector< smithy::AuthSchemeOption > Aws::AmazonWebServiceRequest::GetRequestSpecificSupportedAuth ( ) const

inlinevirtual

Definition at line 236 of file AmazonWebServiceRequest.h.

GetResponseChecksumAlgorithmNames()

virtual Aws::Vector< Aws::String > Aws::AmazonWebServiceRequest::GetResponseChecksumAlgorithmNames ( ) const

inlinevirtual

Definition at line 202 of file AmazonWebServiceRequest.h.

GetResponseStreamFactory()

const Aws::IOStreamFactory & Aws::AmazonWebServiceRequest::GetResponseStreamFactory ( ) const

inline

Retrieves the factory for creating response streams.

Definition at line 129 of file AmazonWebServiceRequest.h.

GetRetryContext()

RetryContext Aws::AmazonWebServiceRequest::GetRetryContext ( ) const

inline

Definition at line 232 of file AmazonWebServiceRequest.h.

GetSelectedCompressionAlgorithm()

virtual Aws::Client::CompressionAlgorithm Aws::AmazonWebServiceRequest::GetSelectedCompressionAlgorithm ( Aws::Client::RequestCompressionConfig  ) const

inlinevirtual

Definition at line 216 of file AmazonWebServiceRequest.h.

GetServiceRequestName()

virtual const char * Aws::AmazonWebServiceRequest::GetServiceRequestName ( ) const

pure virtual

GetServiceSpecificParameters()

virtual std::shared_ptr< Http::ServiceSpecificParameters > Aws::AmazonWebServiceRequest::GetServiceSpecificParameters ( ) const

inlinevirtual

Definition at line 210 of file AmazonWebServiceRequest.h.

GetUserAgentFeatures()

Aws::Set< Aws::Client::UserAgentFeature > Aws::AmazonWebServiceRequest::GetUserAgentFeatures ( ) const

inline

Gets all features that would be included in the requests user agent string.

Returns

a set of features that will be included in the user agent associated with this request.

Definition at line 228 of file AmazonWebServiceRequest.h.

HasEmbeddedError()

virtual bool Aws::AmazonWebServiceRequest::HasEmbeddedError ( Aws::IOStream &  body,

const Aws::Http::HeaderValueCollection &  header 

) const

inlinevirtual

Defaults to false, if a derived class returns true it indicates that the body has an embedded error.

Definition at line 106 of file AmazonWebServiceRequest.h.

HasEventStreamResponse()

virtual bool Aws::AmazonWebServiceRequest::HasEventStreamResponse ( ) const

inlinevirtual

Defaults to false, if this is set to true in derived class, the operation using this request will return an event stream response.

Definition at line 96 of file AmazonWebServiceRequest.h.

IsChunked()

virtual bool Aws::AmazonWebServiceRequest::IsChunked ( ) const

inlinevirtual

Defaults to false, if this is set to true, it supports chunked transfer encoding.

Definition at line 115 of file AmazonWebServiceRequest.h.

IsEventStreamRequest()

virtual bool Aws::AmazonWebServiceRequest::IsEventStreamRequest ( ) const

inlinevirtual

Defaults to false, if this is set to true in derived class, it's an event stream request, which means the payload is consisted by multiple structured events.

Definition at line 91 of file AmazonWebServiceRequest.h.

IsStreaming()

virtual bool Aws::AmazonWebServiceRequest::IsStreaming ( ) const

inlinevirtual

Defaults to false, if this is set to true, it's a streaming request, which means the payload is not well structured bits.

Reimplemented in Aws::AmazonStreamingWebServiceRequest.

Definition at line 86 of file AmazonWebServiceRequest.h.

PutToPresignedUrl()

virtual void Aws::AmazonWebServiceRequest::PutToPresignedUrl ( Aws::Http::URI &  uri) const

inlinevirtual

Put the request to a url for later presigning. This will push the body to the url and then adds the existing query string parameters as normal.

Definition at line 81 of file AmazonWebServiceRequest.h.

RequestChecksumRequired()

virtual bool Aws::AmazonWebServiceRequest::RequestChecksumRequired ( ) const

inlinevirtual

Definition at line 230 of file AmazonWebServiceRequest.h.

SetAdditionalCustomHeaderValue()

virtual void Aws::AmazonWebServiceRequest::SetAdditionalCustomHeaderValue ( const Aws::String &  headerName,

const Aws::String &  headerValue 

)

virtual

Set an additional custom header value under a key. This value will overwrite any previously set or regular header.

SetContinueRequestHandler() [1/2]

virtual void Aws::AmazonWebServiceRequest::SetContinueRequestHandler ( Aws::Http::ContinueRequestHandler &&  continueRequestHandler)

inlinevirtual

Register closure for handling whether or not to continue a request.

Definition at line 164 of file AmazonWebServiceRequest.h.

SetContinueRequestHandler() [2/2]

virtual void Aws::AmazonWebServiceRequest::SetContinueRequestHandler ( const Aws::Http::ContinueRequestHandler &  continueRequestHandler)

inlinevirtual

Register closure for handling whether or not to continue a request.

Definition at line 163 of file AmazonWebServiceRequest.h.

SetDataReceivedEventHandler() [1/2]

virtual void Aws::AmazonWebServiceRequest::SetDataReceivedEventHandler ( Aws::Http::DataReceivedEventHandler &&  dataReceivedEventHandler)

inlinevirtual

Register closure for data received event.

Definition at line 148 of file AmazonWebServiceRequest.h.

SetDataReceivedEventHandler() [2/2]

virtual void Aws::AmazonWebServiceRequest::SetDataReceivedEventHandler ( const Aws::Http::DataReceivedEventHandler &  dataReceivedEventHandler)

inlinevirtual

Register closure for data received event.

Definition at line 147 of file AmazonWebServiceRequest.h.

SetDataSentEventHandler() [1/2]

virtual void Aws::AmazonWebServiceRequest::SetDataSentEventHandler ( Aws::Http::DataSentEventHandler &&  dataSentEventHandler)

inlinevirtual

Register closure for data sent event

Definition at line 156 of file AmazonWebServiceRequest.h.

SetDataSentEventHandler() [2/2]

virtual void Aws::AmazonWebServiceRequest::SetDataSentEventHandler ( const Aws::Http::DataSentEventHandler &  dataSentEventHandler)

inlinevirtual

Register closure for data sent event

Definition at line 155 of file AmazonWebServiceRequest.h.

SetHeadersReceivedEventHandler() [1/2]

virtual void Aws::AmazonWebServiceRequest::SetHeadersReceivedEventHandler ( Aws::Http::HeadersReceivedEventHandler &&  headersReceivedEventHandler)

inlinevirtual

Sets the closure for headers received event.

Definition at line 140 of file AmazonWebServiceRequest.h.

SetHeadersReceivedEventHandler() [2/2]

virtual void Aws::AmazonWebServiceRequest::SetHeadersReceivedEventHandler ( const Aws::Http::HeadersReceivedEventHandler &  headersReceivedEventHandler)

inlinevirtual

Sets the closure for headers received event.

Definition at line 139 of file AmazonWebServiceRequest.h.

SetRequestRetryHandler() [1/2]

virtual void Aws::AmazonWebServiceRequest::SetRequestRetryHandler ( const RequestRetryHandler &  handler)

inlinevirtual

Register closure for notification that a request is being retried

Definition at line 171 of file AmazonWebServiceRequest.h.

SetRequestRetryHandler() [2/2]

virtual void Aws::AmazonWebServiceRequest::SetRequestRetryHandler ( RequestRetryHandler &&  handler)

inlinevirtual

Register closure for notification that a request is being retried

Definition at line 172 of file AmazonWebServiceRequest.h.

SetRequestSignedHandler()

virtual void Aws::AmazonWebServiceRequest::SetRequestSignedHandler ( const RequestSignedHandler &  handler)

inlinevirtual

Register closure for request signed event.

Definition at line 120 of file AmazonWebServiceRequest.h.

SetResponseStreamFactory()

void Aws::AmazonWebServiceRequest::SetResponseStreamFactory ( const Aws::IOStreamFactory &  factory)

inline

Set the response stream factory.

Definition at line 133 of file AmazonWebServiceRequest.h.

SetRetryContext()

void Aws::AmazonWebServiceRequest::SetRetryContext ( const RetryContext &  context) const

inline

Definition at line 234 of file AmazonWebServiceRequest.h.

SetServiceSpecificParameters()

virtual void Aws::AmazonWebServiceRequest::SetServiceSpecificParameters ( const std::shared_ptr< Http::ServiceSpecificParameters > &  serviceSpecificParameters) const

inlinevirtual

Definition at line 208 of file AmazonWebServiceRequest.h.

ShouldComputeContentMd5()

virtual bool Aws::AmazonWebServiceRequest::ShouldComputeContentMd5 ( ) const

inlinevirtual

If this is set to true, content-md5 needs to be computed and set on the request

Definition at line 198 of file AmazonWebServiceRequest.h.

ShouldValidateResponseChecksum()

virtual bool Aws::AmazonWebServiceRequest::ShouldValidateResponseChecksum ( ) const

inlinevirtual

Definition at line 200 of file AmazonWebServiceRequest.h.

SignBody()

virtual bool Aws::AmazonWebServiceRequest::SignBody ( ) const

inlinevirtual

Defaults to true, if this is set to false, then signers, if they support body signing, will not do so

Definition at line 101 of file AmazonWebServiceRequest.h.

Member Data Documentation

m_additionalCustomHeaders

Aws::Http::HeaderValueCollection Aws::AmazonWebServiceRequest::m_additionalCustomHeaders

protected

Definition at line 244 of file AmazonWebServiceRequest.h.

---

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

• src/aws-cpp-sdk-core/include/aws/core/AmazonWebServiceRequest.h