azure::storage::file_request_options Class Reference

Represents a set of timeout and retry policy options that may be specified on a request against the File service. More...

Inheritance diagram for azure::storage::file_request_options:

Public Member Functions
	file_request_options ()
	Initializes a new instance of the azure::storage::file_request_options class. More...
void	apply_defaults (const file_request_options &other, bool apply_expiry=true)
	Applies the default set of request options. More...
bool	use_transactional_md5 () const
	Gets a value indicating whether the content-MD5 hash will be calculated and validated for the request. More...
void	set_use_transactional_md5 (bool value)
	Indicates whether to calculate and validate the content-MD5 hash for the request. More...
bool	disable_content_md5_validation () const
	Gets a value indicating whether content-MD5 validation will be disabled when downloading files. More...
void	set_disable_content_md5_validation (bool value)
	Indicates whether to disable content-MD5 validation when downloading files. More...
bool	store_file_content_md5 () const
	Gets a value indicating whether the content-MD5 hash will be calculated and stored when uploading a file. More...
void	set_store_file_content_md5 (bool value)
	Indicates whether to calculate and store the content-MD5 hash when uploading a file. More...
int	parallelism_factor () const
	Gets the number of ranges that may be simultaneously uploaded or downloaded when uploading or downloading a file that is greater than the value specified by the single_blob_upload_threshold_in_bytes property in size. More...
void	set_parallelism_factor (int value)
	Sets the number of ranges that may be simultaneously uploaded or downloaded when uploading or downloading a file that is greater than the value specified by the single_blob_upload_threshold_in_bytes property in size. More...
Public Member Functions inherited from azure::storage::request_options
azure::storage::retry_policy	retry_policy () const
	Gets the retry policy for the request. More...
void	set_retry_policy (azure::storage::retry_policy retry_policy)
	Sets the retry policy for the request. More...
const std::chrono::seconds	noactivity_timeout () const
void	set_noactivity_timeout (std::chrono::seconds noactivity_timeout)
const std::chrono::seconds	server_timeout () const
	Gets the server timeout for the request. More...
void	set_server_timeout (std::chrono::seconds server_timeout)
	Sets the server timeout for the request. More...
const std::chrono::milliseconds	maximum_execution_time () const
	Gets the maximum execution time across all potential retries. More...
void	set_maximum_execution_time (const std::chrono::milliseconds &maximum_execution_time)
	Sets the maximum execution time across all potential retries. More...
bool	is_maximum_execution_time_customized () const
	Gets if the maximum execution time is set by customer. More...
azure::storage::location_mode	location_mode () const
	Gets the location mode of the request. More...
void	set_location_mode (azure::storage::location_mode location_mode)
	Sets the location mode of the request. More...
size_t	http_buffer_size () const
	Gets the number of bytes to buffer when reading from and writing to a network stream. More...
void	set_http_buffer_size (size_t http_buffer_size)
	Sets the number of bytes to buffer when reading from and writing to a network stream. More...
bool	validate_certificates () const
	Gets the server certificate validation property. More...
void	set_validate_certificates (bool validate_certificates)
	Sets the server certificate validation property. More...
std::chrono::time_point< std::chrono::system_clock >	operation_expiry_time () const
	Gets the expiry time across all potential retries for the request. More...

Detailed Description

Represents a set of timeout and retry policy options that may be specified on a request against the File service.

Constructor & Destructor Documentation

file_request_options()

azure::storage::file_request_options::file_request_options ( )

inline

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

Member Function Documentation

apply_defaults()

void azure::storage::file_request_options::apply_defaults ( const file_request_options &  other, bool  apply_expiry = true  )

inline

Applies the default set of request options.

Parameters

other	A reference to a set of azure::storage::file_request_options.
apply_expiry	Specifies that an expiry time be applied to the request options. This parameter is used internally.

disable_content_md5_validation()

bool azure::storage::file_request_options::disable_content_md5_validation ( ) const

inline

Gets a value indicating whether content-MD5 validation will be disabled when downloading files.

Returns

true to disable content-MD5 validation; otherwise, false.

parallelism_factor()

int azure::storage::file_request_options::parallelism_factor ( ) const

inline

Gets the number of ranges that may be simultaneously uploaded or downloaded when uploading or downloading a file that is greater than the value specified by the single_blob_upload_threshold_in_bytes property in size.

Returns

The number of parallel range upload or download operations that may proceed.

set_disable_content_md5_validation()

void azure::storage::file_request_options::set_disable_content_md5_validation ( bool  value )

inline

Indicates whether to disable content-MD5 validation when downloading files.

Parameters

value

true to disable content-MD5 validation; otherwise, false.

set_parallelism_factor()

void azure::storage::file_request_options::set_parallelism_factor ( int  value )

inline

Sets the number of ranges that may be simultaneously uploaded or downloaded when uploading or downloading a file that is greater than the value specified by the single_blob_upload_threshold_in_bytes property in size.

Parameters

value

The number of parallel range upload or download operations that may proceed.

set_store_file_content_md5()

void azure::storage::file_request_options::set_store_file_content_md5 ( bool  value )

inline

Indicates whether to calculate and store the content-MD5 hash when uploading a file.

Parameters

value

true to calculate and store the content-MD5 hash when uploading a file; otherwise, false.

set_use_transactional_md5()

void azure::storage::file_request_options::set_use_transactional_md5 ( bool  value )

inline

Indicates whether to calculate and validate the content-MD5 hash for the request.

Parameters

value

true to calculate and validate the content-MD5 hash for the request; otherwise, false.

store_file_content_md5()

bool azure::storage::file_request_options::store_file_content_md5 ( ) const

inline

Gets a value indicating whether the content-MD5 hash will be calculated and stored when uploading a file.

Returns

true to calculate and store the content-MD5 hash when uploading a file; otherwise, false.

use_transactional_md5()

bool azure::storage::file_request_options::use_transactional_md5 ( ) const

inline

Gets a value indicating whether the content-MD5 hash will be calculated and validated for the request.

Returns

true if the content-MD5 hash will be calculated and validated for the request; otherwise, false.