public final class CloudQueueClient extends ServiceClient
credentials, endpoint, retryPolicyFactory, timeoutInMs| Constructor and Description |
|---|
CloudQueueClient(URI baseUri,
StorageCredentials credentials)
Initializes a new instance of the
CloudQueueClient class
using the specified Queue service endpoint and account credentials. |
| Modifier and Type | Method and Description |
|---|---|
CloudQueue |
getQueueReference(String queueAddress)
Gets a
CloudQueue object that represents the storage service
queue for the specified address. |
Iterable<CloudQueue> |
listQueues()
Gets an iterable collection of queues for this queue service client.
|
Iterable<CloudQueue> |
listQueues(String prefix)
Returns an iterable collection of queues whose names begin with the
specified prefix in this Queue service client.
|
Iterable<CloudQueue> |
listQueues(String prefix,
QueueListingDetails detailsIncluded,
QueueRequestOptions options,
OperationContext opContext)
Returns an iterable collection of queues whose names begin with the
specified prefix for this Queue service client, using the specified
details setting, request options, and operation context.
|
ResultSegment<CloudQueue> |
listQueuesSegmented()
Gets a result segment of an iterable collection of queues for this Queue
service client.
|
ResultSegment<CloudQueue> |
listQueuesSegmented(String prefix)
Gets a result segment of an iterable collection of queues whose names
begin with the specified prefix for this Queue service client.
|
ResultSegment<CloudQueue> |
listQueuesSegmented(String prefix,
QueueListingDetails detailsIncluded,
int maxResults,
ResultContinuation continuationToken,
QueueRequestOptions options,
OperationContext opContext)
Gets a result segment of an iterable collection of queues whose names
begin with the specified prefix for this queue, using the specified
listing details options, request options, and operation context.
|
void |
uploadServiceProperties(ServiceProperties properties)
Uploads a new configuration of service properties to the storage service,
using the default request options.
|
void |
uploadServiceProperties(ServiceProperties properties,
RequestOptions options,
OperationContext opContext)
Uploads a new configuration of service properties to the storage service,
using the specified request options and operation context.
|
downloadServiceProperties, downloadServiceProperties, getCredentials, getEndpoint, getRetryPolicyFactory, getTimeoutInMs, isUsePathStyleUris, setBaseURI, setCredentials, setRetryPolicyFactory, setTimeoutInMspublic CloudQueueClient(URI baseUri, StorageCredentials credentials)
CloudQueueClient class
using the specified Queue service endpoint and account credentials.baseUri - The Queue service endpoint to use to create the clientcredentials - The account credentials.public CloudQueue getQueueReference(String queueAddress) throws URISyntaxException, StorageException
CloudQueue object that represents the storage service
queue for the specified address.queueAddress - A String that represents the name of the queue,
or the absolute URI to the queue.CloudQueue object that represents a reference to the
queue.URISyntaxException - If the resource URI is invalid.StorageException - If a storage service error occurred during the operation.@DoesServiceRequest public Iterable<CloudQueue> listQueues()
CloudQueue objects that
represent the queues in this client.@DoesServiceRequest public Iterable<CloudQueue> listQueues(String prefix)
prefix - A String that represents the queue name prefix.CloudQueue objects that
represent the queues in this client whose names begin with the
specified prefix.@DoesServiceRequest public Iterable<CloudQueue> listQueues(String prefix, QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext)
prefix - A String that represents the queue name prefix.detailsIncluded - A QueueListingDetails value that indicates whether
queue metadata will be returned.options - A QueueRequestOptions object that specifies any
additional options for the request. Specifying null will use the default request options
from
the associated service client ( CloudQueue).opContext - An OperationContext object that represents the context
for the current operation. This object is used to track
requests to the storage service, and to provide additional
runtime information about the operation.CloudQueue objects that
represents the specified queues for this client.@DoesServiceRequest public ResultSegment<CloudQueue> listQueuesSegmented() throws StorageException
ResultSegment of CloudQueue objects that
contains a segment of the iterable collection of CloudQueue objects that represent the requested
queues in
the storage service.StorageException - If a storage service error occurred during the operation.@DoesServiceRequest public ResultSegment<CloudQueue> listQueuesSegmented(String prefix) throws StorageException
ResultSegment of CloudQueue objects that
contains a segment of the iterable collection of CloudQueue objects that represent the requested
queues in
the storage service.StorageException - If a storage service error occurred during the operation.@DoesServiceRequest public ResultSegment<CloudQueue> listQueuesSegmented(String prefix, QueueListingDetails detailsIncluded, int maxResults, ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext) throws StorageException
prefix - A String that represents the prefix of the queue
name to match.detailsIncluded - A QueueListingDetails value that indicates whether
queue metadata will be returned.maxResults - The maximum number of queue results to retrieve.continuationToken - A ResultContinuation object that represents a
continuation token returned by a previous listing operation.options - A QueueRequestOptions object that specifies any
additional options for the request. Specifying null will use the default request options
from
the associated service client ( CloudQueue).opContext - An OperationContext object that represents the context
for the current operation. This object is used to track
requests to the storage service, and to provide additional
runtime information about the operation.ResultSegment of CloudQueue objects that
contains a segment of the iterable collection of CloudQueue objects that represent the requested
queues in
the storage service.StorageException - If a storage service error occurred during the operation.@DoesServiceRequest public void uploadServiceProperties(ServiceProperties properties) throws StorageException
uploadServiceProperties in class ServiceClientproperties - The ServiceProperties to upload.StorageException - If a storage service error occurred during the operation.@DoesServiceRequest public void uploadServiceProperties(ServiceProperties properties, RequestOptions options, OperationContext opContext) throws StorageException
uploadServiceProperties in class ServiceClientproperties - The ServiceProperties to upload.options - A RequestOptions object that specifies any additional
options for the request. Specifying null will use
the default request options from the associated service client
( CloudBlobClientCloudQueueClient).opContext - An OperationContext object that represents the context
for the current operation. This object is used to track
requests to the storage service, and to provide additional
runtime information about the operation.StorageException - If a storage service error occurred during the operation./**
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/