Provides a client-side logical representation of the Windows Azure Queue service. This client is used to configure and execute requests against the Queue service. More...
Inheritance diagram for azure::storage::cloud_queue_client:
Public Member Functions | |
| cloud_queue_client () | |
| Initializes a new instance of the azure::storage::cloud_queue_client class. More... | |
| cloud_queue_client (storage_uri base_uri) | |
| Initializes a new instance of the azure::storage::cloud_queue_client class. More... | |
| cloud_queue_client (storage_uri base_uri, azure::storage::storage_credentials credentials) | |
| Initializes a new instance of the azure::storage::cloud_queue_client class. More... | |
| cloud_queue_client (storage_uri base_uri, azure::storage::storage_credentials credentials, queue_request_options default_request_options) | |
| Initializes a new instance of the azure::storage::cloud_queue_client class using the specified Queue service endpoint and account credentials. More... | |
| queue_result_iterator | list_queues () const |
| Returns an azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues. More... | |
| queue_result_iterator | list_queues (const utility::string_t &prefix) const |
| Returns an azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues that begin with the specified prefix. More... | |
| WASTORAGE_API queue_result_iterator | list_queues (const utility::string_t &prefix, bool get_metadata, utility::size64_t max_results, const queue_request_options &options, operation_context context) const |
| Returns an azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues that begin with the specified prefix. More... | |
| queue_result_segment | list_queues_segmented (const continuation_token &token) const |
| Returns a result segment containing a collection of queues in the storage account. More... | |
| queue_result_segment | list_queues_segmented (const utility::string_t &prefix, const continuation_token &token) const |
| Returns a result segment containing a collection of queues in the storage account. More... | |
| queue_result_segment | list_queues_segmented (const utility::string_t &prefix, bool get_metadata, int max_results, const continuation_token &token, const queue_request_options &options, operation_context context) const |
| Returns a result segment containing a collection of queues in the storage account. More... | |
| pplx::task< queue_result_segment > | list_queues_segmented_async (const continuation_token &token) const |
| Intitiates an asynchronous operation to return a result segment containing a collection of queue items. More... | |
| pplx::task< queue_result_segment > | list_queues_segmented_async (const utility::string_t &prefix, const continuation_token &token) const |
| Intitiates an asynchronous operation to return a result segment containing a collection of queue items. More... | |
| WASTORAGE_API pplx::task< queue_result_segment > | list_queues_segmented_async (const utility::string_t &prefix, bool get_metadata, int max_results, const continuation_token &token, const queue_request_options &options, operation_context context) const |
| Returns a result segment containing a collection of queues in the storage account. More... | |
| service_properties | download_service_properties () const |
| Gets the service properties for the Queue service client. More... | |
| service_properties | download_service_properties (const queue_request_options &options, operation_context context) const |
| Gets the service properties for the Queue service client. More... | |
| pplx::task< service_properties > | download_service_properties_async () const |
| Intitiates an asynchronous operation to get the properties of the service. More... | |
| WASTORAGE_API pplx::task< service_properties > | download_service_properties_async (const queue_request_options &options, operation_context context) const |
| Intitiates an asynchronous operation to get the properties of the service. More... | |
| void | upload_service_properties (const service_properties &properties, const service_properties_includes &includes) const |
| Sets the service properties for the Queue service client. More... | |
| void | upload_service_properties (const service_properties &properties, const service_properties_includes &includes, const queue_request_options &options, operation_context context) const |
| Sets the service properties for the Queue service client. More... | |
| pplx::task< void > | upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes) const |
| Intitiates an asynchronous operation to set the service properties for the Queue service client. More... | |
| WASTORAGE_API pplx::task< void > | upload_service_properties_async (const service_properties &properties, const service_properties_includes &includes, const queue_request_options &options, operation_context context) const |
| Intitiates an asynchronous operation to set the service properties for the Queue service client. More... | |
| service_stats | download_service_stats () const |
| Gets the service stats for the Queue service client. More... | |
| service_stats | download_service_stats (const queue_request_options &options, operation_context context) const |
| Gets the service stats for the Queue service client. More... | |
| pplx::task< service_stats > | download_service_stats_async () const |
| Intitiates an asynchronous operation to get the stats of the service. More... | |
| WASTORAGE_API pplx::task< service_stats > | download_service_stats_async (const queue_request_options &options, operation_context context) const |
| Intitiates an asynchronous operation to get the stats of the service. More... | |
| WASTORAGE_API cloud_queue | get_queue_reference (utility::string_t queue_name) const |
| Returns a reference to a queue object with the specified name. More... | |
| const queue_request_options & | default_request_options () const |
| WASTORAGE_API void | set_authentication_scheme (azure::storage::authentication_scheme value) override |
| Sets the authentication scheme to use to sign HTTP requests. More... | |
 Public Member Functions inherited from azure::storage::cloud_client | |
| const storage_uri & | base_uri () const |
| Gets the base URI for the service client. More... | |
| const azure::storage::storage_credentials & | credentials () const |
| Gets the storage account credentials for the service client. More... | |
| azure::storage::authentication_scheme | authentication_scheme () const |
| Gets the authentication scheme to use to sign HTTP requests for the service client. More... | |
| std::shared_ptr< protocol::authentication_handler > | authentication_handler () const |
| Gets the authentication handler to use to sign HTTP requests. More... | |
Detailed Description
Provides a client-side logical representation of the Windows Azure Queue service. This client is used to configure and execute requests against the Queue service.
The service client encapsulates the base URI for the Queue service. If the service client will be used for authenticated access, it also encapsulates the credentials for accessing the storage account.
Constructor & Destructor Documentation
◆ cloud_queue_client() [1/4]
|
inline |
Initializes a new instance of the azure::storage::cloud_queue_client class.
◆ cloud_queue_client() [2/4]
|
inlineexplicit |
Initializes a new instance of the azure::storage::cloud_queue_client class.
- Parameters
-
base_uri An azure::storage::storage_uri object containing the Queue service endpoint for all locations.
◆ cloud_queue_client() [3/4]
|
inline |
Initializes a new instance of the azure::storage::cloud_queue_client class.
- Parameters
-
base_uri An azure::storage::storage_uri object containing the Queue service endpoint for all locations. credentials The azure::storage::storage_credentials to use.
◆ cloud_queue_client() [4/4]
|
inline |
Initializes a new instance of the azure::storage::cloud_queue_client class using the specified Queue service endpoint and account credentials.
- Parameters
-
base_uri An azure::storage::storage_uri object containing the Queue service endpoint for all locations. credentials The azure::storage::storage_credentials to use. default_request_options The default azure::storage::queue_request_options object to use for all requests made with this client object.
Member Function Documentation
◆ download_service_properties() [1/2]
|
inline |
Gets the service properties for the Queue service client.
- Returns
- The azure::storage::service_properties for the Queue service client.
◆ download_service_properties() [2/2]
|
inline |
Gets the service properties for the Queue service client.
- Parameters
-
options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- The azure::storage::service_properties for the Queue service client.
◆ download_service_properties_async() [1/2]
|
inline |
Intitiates an asynchronous operation to get the properties of the service.
- Returns
- A pplx::task object of type azure::storage::service_properties that represents the current operation.
◆ download_service_properties_async() [2/2]
| WASTORAGE_API pplx::task<service_properties> azure::storage::cloud_queue_client::download_service_properties_async | ( | const queue_request_options & | options, |
| operation_context | context | ||
| ) | const |
Intitiates an asynchronous operation to get the properties of the service.
- Parameters
-
options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- A pplx::task object of type azure::storage::service_properties that represents the current operation.
◆ download_service_stats() [1/2]
|
inline |
Gets the service stats for the Queue service client.
- Returns
- The azure::storage::service_stats for the Queue service client.
◆ download_service_stats() [2/2]
|
inline |
Gets the service stats for the Queue service client.
- Parameters
-
options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- The azure::storage::service_stats for the Queue service client.
◆ download_service_stats_async() [1/2]
|
inline |
Intitiates an asynchronous operation to get the stats of the service.
- Returns
- A pplx::task object of type azure::storage::service_stats that represents the current operation.
◆ download_service_stats_async() [2/2]
| WASTORAGE_API pplx::task<service_stats> azure::storage::cloud_queue_client::download_service_stats_async | ( | const queue_request_options & | options, |
| operation_context | context | ||
| ) | const |
Intitiates an asynchronous operation to get the stats of the service.
- Parameters
-
options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- A pplx::task object of type azure::storage::service_stats that represents the current operation.
◆ get_queue_reference()
| WASTORAGE_API cloud_queue azure::storage::cloud_queue_client::get_queue_reference | ( | utility::string_t | queue_name | ) | const |
Returns a reference to a queue object with the specified name.
- Parameters
-
queue_name The name of the queue, or an absolute URI to the queue.
- Returns
- The queue.
◆ list_queues() [1/3]
|
inline |
Returns an azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues.
- Returns
- An azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues.
◆ list_queues() [2/3]
|
inline |
Returns an azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues that begin with the specified prefix.
- Parameters
-
prefix The queue name prefix.
- Returns
- An azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues.
◆ list_queues() [3/3]
| WASTORAGE_API queue_result_iterator azure::storage::cloud_queue_client::list_queues | ( | const utility::string_t & | prefix, |
| bool | get_metadata, | ||
| utility::size64_t | max_results, | ||
| const queue_request_options & | options, | ||
| operation_context | context | ||
| ) | const |
Returns an azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues that begin with the specified prefix.
- Parameters
-
prefix The queue name prefix. get_metadata A flag that specifies whether to retrieve queue metadata. max_results A non-negative integer value that indicates the maximum number of results to be returned. If this value is zero, the maximum possible number of results will be returned. options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- An azure::storage::queue_result_iterator that can be used to to lazily enumerate a collection of queues.
◆ list_queues_segmented() [1/3]
|
inline |
Returns a result segment containing a collection of queues in the storage account.
- Parameters
-
token A continuation token returned by a previous listing operation.
- Returns
- A result segment containing a collection of queues.
◆ list_queues_segmented() [2/3]
|
inline |
Returns a result segment containing a collection of queues in the storage account.
- Parameters
-
token A continuation token returned by a previous listing operation. prefix The queue name prefix.
- Returns
- A result segment containing a collection of queues.
◆ list_queues_segmented() [3/3]
|
inline |
Returns a result segment containing a collection of queues in the storage account.
- Parameters
-
token A continuation token returned by a previous listing operation. prefix The queue name prefix. get_metadata A flag that specifies whether to retrieve queue metadata. max_results A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
- Parameters
-
options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- A result segment containing a collection of queues.
◆ list_queues_segmented_async() [1/3]
|
inline |
Intitiates an asynchronous operation to return a result segment containing a collection of queue items.
- Parameters
-
token A continuation token returned by a previous listing operation.
- Returns
- A pplx::task object of type azure::storage::queue_result_segment that represents the current operation.
◆ list_queues_segmented_async() [2/3]
|
inline |
Intitiates an asynchronous operation to return a result segment containing a collection of queue items.
- Parameters
-
token A continuation token returned by a previous listing operation. prefix The queue name prefix.
- Returns
- A pplx::task object of type azure::storage::queue_result_segment that represents the current operation.
◆ list_queues_segmented_async() [3/3]
| WASTORAGE_API pplx::task<queue_result_segment> azure::storage::cloud_queue_client::list_queues_segmented_async | ( | const utility::string_t & | prefix, |
| bool | get_metadata, | ||
| int | max_results, | ||
| const continuation_token & | token, | ||
| const queue_request_options & | options, | ||
| operation_context | context | ||
| ) | const |
Returns a result segment containing a collection of queues in the storage account.
- Parameters
-
token A continuation token returned by a previous listing operation. prefix The queue name prefix. get_metadata A flag that specifies whether to retrieve queue metadata. max_results A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is 0, the maximum possible number of results will be returned, up to 5000.
- Parameters
-
options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- A pplx::task object of type azure::storage::queue_result_segment that represents the current operation.
◆ set_authentication_scheme()
|
overridevirtual |
Sets the authentication scheme to use to sign HTTP requests.
- Parameters
-
value The authentication scheme.
Reimplemented from azure::storage::cloud_client.
◆ upload_service_properties() [1/2]
|
inline |
Sets the service properties for the Queue service client.
- Parameters
-
properties The azure::storage::service_properties for the Queue service client. includes An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
◆ upload_service_properties() [2/2]
|
inline |
Sets the service properties for the Queue service client.
- Parameters
-
properties The azure::storage::service_properties for the Queue service client. includes An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties. options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
◆ upload_service_properties_async() [1/2]
|
inline |
Intitiates an asynchronous operation to set the service properties for the Queue service client.
- Parameters
-
properties The azure::storage::service_properties for the Queue service client. includes An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties.
- Returns
- A pplx::task object that represents the current operation.
◆ upload_service_properties_async() [2/2]
| WASTORAGE_API pplx::task<void> azure::storage::cloud_queue_client::upload_service_properties_async | ( | const service_properties & | properties, |
| const service_properties_includes & | includes, | ||
| const queue_request_options & | options, | ||
| operation_context | context | ||
| ) | const |
Intitiates an asynchronous operation to set the service properties for the Queue service client.
- Parameters
-
properties The azure::storage::service_properties for the Queue service client. includes An azure::storage::service_properties_includes enumeration describing which items to include when setting service properties. options An azure::storage::queue_request_options object that specifies additional options for the request. context An azure::storage::operation_context object that represents the context for the current operation.
- Returns
- A pplx::task object that represents the current operation.
