Azure::Core::RequestFailedException Class Reference

An error while trying to send a request to Azure service.

#include <exception.hpp>

Inheritance diagram for Azure::Core::RequestFailedException:

Public Member Functions
	RequestFailedException (std::string const &whatArg)
	Constructs a new RequestFailedException with a message string. More...
	RequestFailedException (const std::string &message, std::unique_ptr< Azure::Core::Http::RawResponse > rawResponse)
	Constructs a new RequestFailedException object with an HTTP raw response. More...
	RequestFailedException (std::unique_ptr< Azure::Core::Http::RawResponse > &rawResponse)
	Constructs a new RequestFailedException object with an HTTP raw response. More...
	RequestFailedException (const RequestFailedException &other)
	Constructs a new RequestFailedException by copying from an existing one. More...
	RequestFailedException (RequestFailedException &&other)=default
	Constructs a new RequestFailedException by moving in an existing one. More...
RequestFailedException &	operator= (const RequestFailedException &)=delete
	An instance of RequestFailedException class cannot be assigned. More...
RequestFailedException &	operator= (RequestFailedException &&)=delete
	An instance of RequestFailedException class cannot be moved into another instance after creation. More...
	~RequestFailedException ()=default
	Destructs RequestFailedException. More...

Public Attributes
Azure::Core::Http::HttpStatusCode	StatusCode = Azure::Core::Http::HttpStatusCode::None
	The HTTP response code. More...
std::string	ReasonPhrase
	The HTTP reason phrase from the response. More...
std::string	ClientRequestId
	The client request header from the HTTP response. More...
std::string	RequestId
	The request ID header from the HTTP response. More...
std::string	ErrorCode
	The error code from service returned in the HTTP response. More...
std::string	Message
	The error message from the service returned in the HTTP response. More...
std::unique_ptr< Azure::Core::Http::RawResponse >	RawResponse
	The entire HTTP raw response. More...

Constructor & Destructor Documentation

RequestFailedException() [1/5]

Azure::Core::RequestFailedException::RequestFailedException ( std::string const &  whatArg )

inlineexplicit

Note

An Exception without an HTTP raw response represents an exception that happened before sending the request to the server.

Parameters

whatArg

The explanatory string.

RequestFailedException() [2/5]

Azure::Core::RequestFailedException::RequestFailedException ( const std::string &  message, std::unique_ptr< Azure::Core::Http::RawResponse >  rawResponse  )

explicit

Note

The HTTP raw response is parsed to populate information expected from all Azure Services like the status code, reason phrase and some headers like the request ID. A concrete Service exception which derives from this exception uses its constructor to parse the HTTP raw response adding the service specific values to the exception.

Parameters

message	The error description.
rawResponse	The HTTP raw response from the service.

RequestFailedException() [3/5]

Azure::Core::RequestFailedException::RequestFailedException ( std::unique_ptr< Azure::Core::Http::RawResponse > &  rawResponse )

explicit

Note

The HTTP raw response is parsed to populate information expected from all Azure Services like the status code, reason phrase and some headers like the request ID. A concrete Service exception which derives from this exception uses its constructor to parse the HTTP raw response adding the service specific values to the exception.

Parameters

rawResponse

The HTTP raw response from the service.

RequestFailedException() [4/5]

Azure::Core::RequestFailedException::RequestFailedException ( const RequestFailedException &  other )

inline

Note

Copies the Azure::Core::Http::RawResponse into the new RequestFailedException.

Parameters

other

The RequestFailedException to be copied.

RequestFailedException() [5/5]

Azure::Core::RequestFailedException::RequestFailedException ( RequestFailedException &&  other )

default

Parameters

other

The RequestFailedException to move in.

~RequestFailedException()

Azure::Core::RequestFailedException::~RequestFailedException ( )

default

Member Function Documentation

operator=() [1/2]

RequestFailedException& Azure::Core::RequestFailedException::operator= ( const RequestFailedException &  )

delete

operator=() [2/2]

RequestFailedException& Azure::Core::RequestFailedException::operator= ( RequestFailedException &&  )

delete

Member Data Documentation

ClientRequestId

std::string Azure::Core::RequestFailedException::ClientRequestId

ErrorCode

std::string Azure::Core::RequestFailedException::ErrorCode

Message

std::string Azure::Core::RequestFailedException::Message

Note

This string is purely for informational or diagnostic purposes, and should't be relied on at runtime.

RawResponse

std::unique_ptr<Azure::Core::Http::RawResponse> Azure::Core::RequestFailedException::RawResponse

ReasonPhrase

std::string Azure::Core::RequestFailedException::ReasonPhrase

RequestId

std::string Azure::Core::RequestFailedException::RequestId

StatusCode

Azure::Core::Http::HttpStatusCode Azure::Core::RequestFailedException::StatusCode = Azure::Core::Http::HttpStatusCode::None

---

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

• inc/azure/core/exception.hpp
• src/exception.cpp