azure::storage::request_result Class Reference

Represents a result returned by a request. More...

Public Member Functions
	request_result ()
	Initializes a new instance of the azure::storage::request_result class. More...
	request_result (utility::datetime start_time, storage_location target_location)
	Initializes a new instance of the azure::storage::request_result class. More...
WASTORAGE_API	request_result (utility::datetime start_time, storage_location target_location, const web::http::http_response &response, bool parse_body_as_error)
	Initializes a new instance of the azure::storage::request_result class. More...
WASTORAGE_API	request_result (utility::datetime start_time, storage_location target_location, const web::http::http_response &response, web::http::status_code http_status_code, storage_extended_error extended_error)
	Initializes a new instance of the azure::storage::request_result class. More...
bool	is_response_available () const
	Indicates whether a response is available for the request. More...
utility::datetime	start_time () const
	Gets the start time of the request. More...
storage_location	target_location () const
	Gets the target location for the request. More...
utility::datetime	end_time () const
	Gets the end time of the request. More...
web::http::status_code	http_status_code () const
	Gets the HTTP status code for the request. More...
void	set_http_status_code (web::http::status_code value)
	Sets the HTTP status code for the request. More...
const utility::string_t &	service_request_id () const
	Gets the service request ID. More...
utility::datetime	request_date () const
	Gets the service request date. More...
utility::size64_t	content_length () const
	Gets the content length for the request. More...
const utility::string_t &	content_md5 () const
	Gets the content-MD5 hash for the request. More...
const utility::string_t &	content_crc64 () const
	Gets the content-CRC64 hash for the request. More...
const utility::string_t &	etag () const
	Gets the ETag for the request. More...
const storage_extended_error &	extended_error () const
	Gets extended error information for the request. More...
void	set_extended_error (storage_extended_error value)
	Sets extended error information for the request. More...

Detailed Description

Represents a result returned by a request.

Constructor & Destructor Documentation

request_result() [1/4]

azure::storage::request_result::request_result ( )

inline

Initializes a new instance of the azure::storage::request_result class.

request_result() [2/4]

azure::storage::request_result::request_result ( utility::datetime  start_time, storage_location  target_location  )

inline

Initializes a new instance of the azure::storage::request_result class.

Parameters

start_time	The start time of the request.
target_location	The target location for the request.

request_result() [3/4]

WASTORAGE_API azure::storage::request_result::request_result	(	utility::datetime	start_time,
		storage_location	target_location,
		const web::http::http_response &	response,
		bool	parse_body_as_error
	)

Initializes a new instance of the azure::storage::request_result class.

Parameters

start_time	The start time of the request.
target_location	The target location for the request.
response	The HTTP response to read.
parse_body_as_error	A flag that indicates whether to parse error data from the response body.

request_result() [4/4]

WASTORAGE_API azure::storage::request_result::request_result	(	utility::datetime	start_time,
		storage_location	target_location,
		const web::http::http_response &	response,
		web::http::status_code	http_status_code,
		storage_extended_error	extended_error
	)

Initializes a new instance of the azure::storage::request_result class.

Parameters

start_time	The start time of the request.
target_location	The target location for the request.
response	The HTTP response to read.
http_status_code	The HTTP status code for the request.
extended_error	The extended error information for the request.

Member Function Documentation

content_crc64()

const utility::string_t& azure::storage::request_result::content_crc64 ( ) const

inline

Gets the content-CRC64 hash for the request.

Returns

A string containing the content-CRC64 hash for the request.

content_length()

utility::size64_t azure::storage::request_result::content_length ( ) const

inline

Gets the content length for the request.

Returns

The content length for the request.

content_md5()

const utility::string_t& azure::storage::request_result::content_md5 ( ) const

inline

Gets the content-MD5 hash for the request.

Returns

A string containing the content-MD5 hash for the request.

end_time()

utility::datetime azure::storage::request_result::end_time ( ) const

inline

Gets the end time of the request.

Returns

The end time of the request.

etag()

const utility::string_t& azure::storage::request_result::etag ( ) const

inline

Gets the ETag for the request.

Returns

The ETag for the request.

extended_error()

const storage_extended_error& azure::storage::request_result::extended_error ( ) const

inline

Gets extended error information for the request.

Returns

The extended error information for the request.

http_status_code()

web::http::status_code azure::storage::request_result::http_status_code ( ) const

inline

Gets the HTTP status code for the request.

Returns

The HTTP status code for the request.

is_response_available()

bool azure::storage::request_result::is_response_available ( ) const

inline

Indicates whether a response is available for the request.

Returns

true if a response is available.

request_date()

utility::datetime azure::storage::request_result::request_date ( ) const

inline

Gets the service request date.

Returns

The service request date.

service_request_id()

const utility::string_t& azure::storage::request_result::service_request_id ( ) const

inline

Gets the service request ID.

Returns

The service request ID.

set_extended_error()

void azure::storage::request_result::set_extended_error ( storage_extended_error  value )

inline

Sets extended error information for the request.

Parameters

value

The extended error information for the request.

set_http_status_code()

void azure::storage::request_result::set_http_status_code ( web::http::status_code  value )

inline

Sets the HTTP status code for the request.

Parameters

value

The HTTP status code for the request.

start_time()

utility::datetime azure::storage::request_result::start_time ( ) const

inline

Gets the start time of the request.

Returns

The start time of the request.

target_location()

storage_location azure::storage::request_result::target_location ( ) const

inline

Gets the target location for the request.

Returns

The target location for the request.