Microsoft Azure Storage Client Library for C++  7.5.0
The Microsoft Azure Storage Client Library for C++ is a library for working with the Azure Storage Services in C++.
Public Member Functions | List of all members
azure::storage::table_request_options Class Reference

Represents a set of options that may be specified for a request against the Table service. More...

Inheritance diagram for azure::storage::table_request_options:
azure::storage::request_options

Public Member Functions

 table_request_options ()
 Initializes a new instance of the azure::storage::table_request_options class. More...
 
void apply_defaults (const table_request_options &other)
 Applies the default set of request options. More...
 
azure::storage::table_payload_format payload_format () const
 Gets the azure::storage::table_payload_format to use for the request. More...
 
void set_payload_format (azure::storage::table_payload_format payload_format)
 Sets the azure::storage::table_payload_format that will be used for the request. 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 options that may be specified for a request against the Table service.

Constructor & Destructor Documentation

◆ table_request_options()

azure::storage::table_request_options::table_request_options ( )
inline

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

Member Function Documentation

◆ apply_defaults()

void azure::storage::table_request_options::apply_defaults ( const table_request_options other)
inline

Applies the default set of request options.

Parameters
otherA reference to a set of azure::storage::table_request_options.

◆ payload_format()

azure::storage::table_payload_format azure::storage::table_request_options::payload_format ( ) const
inline

Gets the azure::storage::table_payload_format to use for the request.

Returns
An azure::storage::table_payload_format object.

◆ set_payload_format()

void azure::storage::table_request_options::set_payload_format ( azure::storage::table_payload_format  payload_format)
inline

Sets the azure::storage::table_payload_format that will be used for the request.

Parameters
payload_formatThe azure::storage::table_payload_format to use.