AWS SDK for C++  1.7.207
AWS SDK for C++
Public Member Functions | 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 (const AWSError< CoreErrors > &rhs)
 
AWSErroroperator= (const AWSError< ERROR_TYPE > &)=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)
 
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)
 

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 82 of file AWSClient.h.

Constructor & Destructor Documentation

◆ AWSError() [1/4]

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 38 of file AWSError.h.

◆ AWSError() [2/4]

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 42 of file AWSError.h.

◆ AWSError() [3/4]

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 48 of file AWSError.h.

◆ AWSError() [4/4]

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

Definition at line 53 of file AWSError.h.

Member Function Documentation

◆ GetErrorType()

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

Gets underlying errorType.

Definition at line 67 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 71 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 79 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 103 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 91 of file AWSError.h.

◆ operator=()

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

Copy 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 99 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 75 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 83 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 107 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 95 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 87 of file AWSError.h.


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