AWS SDK for C++  1.8.7
AWS SDK for C++
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Aws::Client::AWSError< ERROR_TYPE > Class Template Reference

#include <AWSClient.h>

Public Member Functions

 AWSError ()
 
 AWSError (ERROR_TYPE errorType, Aws::String exceptionName, const Aws::String message, bool isRetryable)
 
 AWSError (ERROR_TYPE errorType, bool isRetryable)
 
 AWSError (AWSError &&rhs)=default
 
 AWSError (const AWSError &rhs)=default
 
template<typename OTHER_ERROR_TYPE >
 AWSError (AWSError< OTHER_ERROR_TYPE > &&rhs)
 
template<typename OTHER_ERROR_TYPE >
 AWSError (const AWSError< OTHER_ERROR_TYPE > &rhs)
 
AWSErroroperator= (const AWSError< ERROR_TYPE > &)=default
 
AWSErroroperator= (AWSError< ERROR_TYPE > &&other)=default
 
const ERROR_TYPE GetErrorType () const
 
const Aws::StringGetExceptionName () const
 
void SetExceptionName (const Aws::String &exceptionName)
 
const Aws::StringGetMessage () const
 
void SetMessage (const Aws::String &message)
 
const Aws::StringGetRemoteHostIpAddress () const
 
void SetRemoteHostIpAddress (const Aws::String &remoteHostIpAddress)
 
const Aws::StringGetRequestId () const
 
void SetRequestId (const Aws::String &requestId)
 
bool ShouldRetry () const
 
const Aws::Http::HeaderValueCollectionGetResponseHeaders () const
 
void SetResponseHeaders (const Aws::Http::HeaderValueCollection &headers)
 
bool ResponseHeaderExists (const Aws::String &headerName) const
 
Aws::Http::HttpResponseCode GetResponseCode () const
 
void SetResponseCode (Aws::Http::HttpResponseCode responseCode)
 

Protected Member Functions

ErrorPayloadType GetErrorPayloadType ()
 
void SetXmlPayload (const Aws::Utils::Xml::XmlDocument &xmlPayload)
 
void SetXmlPayload (Aws::Utils::Xml::XmlDocument &&xmlPayload)
 
const Aws::Utils::Xml::XmlDocumentGetXmlPayload () const
 
void SetJsonPayload (const Aws::Utils::Json::JsonValue &jsonPayload)
 
void SetJsonPayload (Aws::Utils::Json::JsonValue &&jsonPayload)
 
const Aws::Utils::Json::JsonValueGetJsonPayload () const
 

Protected Attributes

ERROR_TYPE m_errorType
 
Aws::String m_exceptionName
 
Aws::String m_message
 
Aws::String m_remoteHostIpAddress
 
Aws::String m_requestId
 
Aws::Http::HeaderValueCollection m_responseHeaders
 
Aws::Http::HttpResponseCode m_responseCode
 
bool m_isRetryable
 
ErrorPayloadType m_errorPayloadType
 
Aws::Utils::Xml::XmlDocument m_xmlPayload
 
Aws::Utils::Json::JsonValue m_jsonPayload
 

Friends

class XmlErrorMarshaller
 
class JsonErrorMarshaller
 
template<typename T >
class AWSError
 

Detailed Description

template<typename ERROR_TYPE>
class Aws::Client::AWSError< ERROR_TYPE >

Container for Error enumerations with additional exception information. Name, message, retryable etc....

Definition at line 72 of file AWSClient.h.

Constructor & Destructor Documentation

◆ AWSError() [1/7]

template<typename ERROR_TYPE>
Aws::Client::AWSError< ERROR_TYPE >::AWSError ( )
inline

Initializes AWSError object as empty with the error not being retryable.

Definition at line 44 of file AWSError.h.

◆ AWSError() [2/7]

template<typename ERROR_TYPE>
Aws::Client::AWSError< ERROR_TYPE >::AWSError ( ERROR_TYPE  errorType,
Aws::String  exceptionName,
const Aws::String  message,
bool  isRetryable 
)
inline

Initializes AWSError object with errorType, exceptionName, message, and retryable flag.

Definition at line 48 of file AWSError.h.

◆ AWSError() [3/7]

template<typename ERROR_TYPE>
Aws::Client::AWSError< ERROR_TYPE >::AWSError ( ERROR_TYPE  errorType,
bool  isRetryable 
)
inline

Initializes AWSError object with errorType and retryable flag. ExceptionName and message are empty.

Definition at line 55 of file AWSError.h.

◆ AWSError() [4/7]

template<typename ERROR_TYPE>
Aws::Client::AWSError< ERROR_TYPE >::AWSError ( AWSError< ERROR_TYPE > &&  rhs)
default

◆ AWSError() [5/7]

template<typename ERROR_TYPE>
Aws::Client::AWSError< ERROR_TYPE >::AWSError ( const AWSError< ERROR_TYPE > &  rhs)
default

◆ AWSError() [6/7]

template<typename ERROR_TYPE>
template<typename OTHER_ERROR_TYPE >
Aws::Client::AWSError< ERROR_TYPE >::AWSError ( AWSError< OTHER_ERROR_TYPE > &&  rhs)
inline

Definition at line 63 of file AWSError.h.

◆ AWSError() [7/7]

template<typename ERROR_TYPE>
template<typename OTHER_ERROR_TYPE >
Aws::Client::AWSError< ERROR_TYPE >::AWSError ( const AWSError< OTHER_ERROR_TYPE > &  rhs)
inline

Definition at line 72 of file AWSError.h.

Member Function Documentation

◆ GetErrorPayloadType()

template<typename ERROR_TYPE>
ErrorPayloadType Aws::Client::AWSError< ERROR_TYPE >::GetErrorPayloadType ( )
inlineprotected

Definition at line 156 of file AWSError.h.

◆ GetErrorType()

template<typename ERROR_TYPE>
const ERROR_TYPE Aws::Client::AWSError< ERROR_TYPE >::GetErrorType ( ) const
inline

Gets underlying errorType.

Definition at line 93 of file AWSError.h.

◆ GetExceptionName()

template<typename ERROR_TYPE>
const Aws::String& Aws::Client::AWSError< ERROR_TYPE >::GetExceptionName ( ) const
inline

Gets the underlying ExceptionName.

Definition at line 97 of file AWSError.h.

◆ GetJsonPayload()

template<typename ERROR_TYPE>
const Aws::Utils::Json::JsonValue& Aws::Client::AWSError< ERROR_TYPE >::GetJsonPayload ( ) const
inlineprotected

Definition at line 182 of file AWSError.h.

◆ GetMessage()

template<typename ERROR_TYPE>
const Aws::String& Aws::Client::AWSError< ERROR_TYPE >::GetMessage ( ) const
inline

Gets the error message.

Definition at line 105 of file AWSError.h.

◆ GetRemoteHostIpAddress()

template<typename ERROR_TYPE>
const Aws::String& Aws::Client::AWSError< ERROR_TYPE >::GetRemoteHostIpAddress ( ) const
inline

Gets the resolved remote host IP address. This value is only available after DNS resolution and with CURL http client right now. Otherwise an empty string is returned.

Definition at line 115 of file AWSError.h.

◆ GetRequestId()

template<typename ERROR_TYPE>
const Aws::String& Aws::Client::AWSError< ERROR_TYPE >::GetRequestId ( ) const
inline

Gets the request ID. This value is available after request is made and when services return it in response. Otherwise an empty string is returned.

Definition at line 125 of file AWSError.h.

◆ GetResponseCode()

template<typename ERROR_TYPE>
Aws::Http::HttpResponseCode Aws::Client::AWSError< ERROR_TYPE >::GetResponseCode ( ) const
inline

Gets the response code from the http response

Definition at line 149 of file AWSError.h.

◆ GetResponseHeaders()

template<typename ERROR_TYPE>
const Aws::Http::HeaderValueCollection& Aws::Client::AWSError< ERROR_TYPE >::GetResponseHeaders ( ) const
inline

Gets the response headers from the http response.

Definition at line 137 of file AWSError.h.

◆ GetXmlPayload()

template<typename ERROR_TYPE>
const Aws::Utils::Xml::XmlDocument& Aws::Client::AWSError< ERROR_TYPE >::GetXmlPayload ( ) const
inlineprotected

Definition at line 167 of file AWSError.h.

◆ operator=() [1/2]

template<typename ERROR_TYPE>
AWSError& Aws::Client::AWSError< ERROR_TYPE >::operator= ( const AWSError< ERROR_TYPE > &  )
default

Copy assignment operator

◆ operator=() [2/2]

template<typename ERROR_TYPE>
AWSError& Aws::Client::AWSError< ERROR_TYPE >::operator= ( AWSError< ERROR_TYPE > &&  other)
default

Move assignment operator

◆ ResponseHeaderExists()

template<typename ERROR_TYPE>
bool Aws::Client::AWSError< ERROR_TYPE >::ResponseHeaderExists ( const Aws::String headerName) const
inline

Tests whether or not a header exists.

Definition at line 145 of file AWSError.h.

◆ SetExceptionName()

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetExceptionName ( const Aws::String exceptionName)
inline

Sets the underlying ExceptionName.

Definition at line 101 of file AWSError.h.

◆ SetJsonPayload() [1/2]

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetJsonPayload ( const Aws::Utils::Json::JsonValue jsonPayload)
inlineprotected

Definition at line 172 of file AWSError.h.

◆ SetJsonPayload() [2/2]

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetJsonPayload ( Aws::Utils::Json::JsonValue &&  jsonPayload)
inlineprotected

Definition at line 177 of file AWSError.h.

◆ SetMessage()

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetMessage ( const Aws::String message)
inline

Sets the error message

Definition at line 109 of file AWSError.h.

◆ SetRemoteHostIpAddress()

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetRemoteHostIpAddress ( const Aws::String remoteHostIpAddress)
inline

Sets the resolved remote host IP address.

Definition at line 119 of file AWSError.h.

◆ SetRequestId()

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetRequestId ( const Aws::String requestId)
inline

Sets the request ID.

Definition at line 129 of file AWSError.h.

◆ SetResponseCode()

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetResponseCode ( Aws::Http::HttpResponseCode  responseCode)
inline

Sets the response code from the http response

Definition at line 153 of file AWSError.h.

◆ SetResponseHeaders()

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetResponseHeaders ( const Aws::Http::HeaderValueCollection headers)
inline

Sets the response headers from the http response.

Definition at line 141 of file AWSError.h.

◆ SetXmlPayload() [1/2]

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetXmlPayload ( const Aws::Utils::Xml::XmlDocument xmlPayload)
inlineprotected

Definition at line 157 of file AWSError.h.

◆ SetXmlPayload() [2/2]

template<typename ERROR_TYPE>
void Aws::Client::AWSError< ERROR_TYPE >::SetXmlPayload ( Aws::Utils::Xml::XmlDocument &&  xmlPayload)
inlineprotected

Definition at line 162 of file AWSError.h.

◆ ShouldRetry()

template<typename ERROR_TYPE>
bool Aws::Client::AWSError< ERROR_TYPE >::ShouldRetry ( ) const
inline

Returns whether or not this error is eligible for retry.

Definition at line 133 of file AWSError.h.

Friends And Related Function Documentation

◆ AWSError

template<typename ERROR_TYPE>
template<typename T >
friend class AWSError
friend

Definition at line 39 of file AWSError.h.

◆ JsonErrorMarshaller

template<typename ERROR_TYPE>
friend class JsonErrorMarshaller
friend

Definition at line 38 of file AWSError.h.

◆ XmlErrorMarshaller

template<typename ERROR_TYPE>
friend class XmlErrorMarshaller
friend

Definition at line 37 of file AWSError.h.

Member Data Documentation

◆ m_errorPayloadType

template<typename ERROR_TYPE>
ErrorPayloadType Aws::Client::AWSError< ERROR_TYPE >::m_errorPayloadType
protected

Definition at line 197 of file AWSError.h.

◆ m_errorType

template<typename ERROR_TYPE>
ERROR_TYPE Aws::Client::AWSError< ERROR_TYPE >::m_errorType
protected

Definition at line 188 of file AWSError.h.

◆ m_exceptionName

template<typename ERROR_TYPE>
Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_exceptionName
protected

Definition at line 189 of file AWSError.h.

◆ m_isRetryable

template<typename ERROR_TYPE>
bool Aws::Client::AWSError< ERROR_TYPE >::m_isRetryable
protected

Definition at line 195 of file AWSError.h.

◆ m_jsonPayload

template<typename ERROR_TYPE>
Aws::Utils::Json::JsonValue Aws::Client::AWSError< ERROR_TYPE >::m_jsonPayload
protected

Definition at line 199 of file AWSError.h.

◆ m_message

template<typename ERROR_TYPE>
Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_message
protected

Definition at line 190 of file AWSError.h.

◆ m_remoteHostIpAddress

template<typename ERROR_TYPE>
Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_remoteHostIpAddress
protected

Definition at line 191 of file AWSError.h.

◆ m_requestId

template<typename ERROR_TYPE>
Aws::String Aws::Client::AWSError< ERROR_TYPE >::m_requestId
protected

Definition at line 192 of file AWSError.h.

◆ m_responseCode

template<typename ERROR_TYPE>
Aws::Http::HttpResponseCode Aws::Client::AWSError< ERROR_TYPE >::m_responseCode
protected

Definition at line 194 of file AWSError.h.

◆ m_responseHeaders

template<typename ERROR_TYPE>
Aws::Http::HeaderValueCollection Aws::Client::AWSError< ERROR_TYPE >::m_responseHeaders
protected

Definition at line 193 of file AWSError.h.

◆ m_xmlPayload

template<typename ERROR_TYPE>
Aws::Utils::Xml::XmlDocument Aws::Client::AWSError< ERROR_TYPE >::m_xmlPayload
protected

Definition at line 198 of file AWSError.h.


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