com.microsoft.azure.storage.queue

Class CloudQueueClient

java.lang.Object

com.microsoft.azure.storage.ServiceClient

com.microsoft.azure.storage.queue.CloudQueueClient

public final class CloudQueueClient
extends ServiceClient

Provides a service client for accessing the Microsoft Azure Queue service.

Field Summary

Fields inherited from class com.microsoft.azure.storage.ServiceClient

credentials

Constructor Summary

Constructors

Constructor and Description
CloudQueueClient(StorageUri baseUri, StorageCredentials credentials) Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.
CloudQueueClient(URI baseUri, StorageCredentials credentials) Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

Method Summary

Modifier and Type	Method and Description
ServiceProperties	downloadServiceProperties() Retrieves the current ServiceProperties for the given storage service.
ServiceProperties	downloadServiceProperties(QueueRequestOptions options, OperationContext opContext) Retrieves the current ServiceProperties for the given storage service.
QueueRequestOptions	getDefaultRequestOptions() Gets the QueueRequestOptions that is used for requests associated with this CloudQueueClient
CloudQueue	getQueueReference(String queueName) Gets a CloudQueue object with the specified name.
ServiceStats	getServiceStats() Queries the service for the ServiceStats.
ServiceStats	getServiceStats(QueueRequestOptions options, OperationContext opContext) Queries the service for the ServiceStats.
protected boolean	isUsePathStyleUris()
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, Integer 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	setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions) Sets the QueueRequestOptions that is used for any queue accessed with this CloudQueueClient object.
void	uploadServiceProperties(ServiceProperties properties) Uploads a new ServiceProperties configuration to the given storage service.
void	uploadServiceProperties(ServiceProperties properties, QueueRequestOptions options, OperationContext opContext) Uploads a new ServiceProperties configuration to the given storage service.

Methods inherited from class com.microsoft.azure.storage.ServiceClient

downloadServicePropertiesImpl, getCredentials, getEndpoint, getServiceStatsImpl, getStorageUri, setCredentials, setStorageUri, uploadServicePropertiesImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudQueueClient

public CloudQueueClient(URI baseUri,
                        StorageCredentials credentials)

Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

Parameters:

baseUri - A java.net.URI object that represents the Queue service endpoint used to create the client.

credentials - A StorageCredentials object that represents the account credentials.

CloudQueueClient

public CloudQueueClient(StorageUri baseUri,
                        StorageCredentials credentials)

Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

Parameters:

baseUri - A StorageUri object that represents the Queue service endpoint used to create the client.

credentials - A StorageCredentials object that represents the account credentials.

Method Detail

getQueueReference

public CloudQueue getQueueReference(String queueName)
                             throws URISyntaxException,
                                    StorageException

Gets a CloudQueue object with the specified name.

Parameters:

queueName - The name of the queue, which must adhere to queue naming rules. The queue name should not include any path separator characters (/). Queue names must be lowercase, between 3-63 characters long and must start with a letter or number. Queue names may contain only letters, numbers, and the dash (-) character.

Returns:

A reference to a CloudQueue object.

Throws:

URISyntaxException - If the resource URI constructed based on the queueName is invalid.

StorageException - If a storage service error occurred.

See Also:

Naming Queues and Metadata

listQueues

@DoesServiceRequest
public Iterable<CloudQueue> listQueues()

Gets an iterable collection of queues for this queue service client.

Returns:

An iterable collection of CloudQueue objects retrieved lazily that represent the queues in this client.

listQueues

@DoesServiceRequest
public Iterable<CloudQueue> listQueues(String prefix)

Returns an iterable collection of queues whose names begin with the specified prefix in this Queue service client.

Parameters:

prefix - A String that represents the queue name prefix.

Returns:

An iterable collection of CloudQueue objects retrieved lazily that represent the queues in this client whose names begin with the specified prefix.

listQueues

@DoesServiceRequest
public 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.

Parameters:

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.

Returns:

An iterable collection of CloudQueue objects retrieved lazily that represents the specified queues for this client.

listQueuesSegmented

@DoesServiceRequest
public ResultSegment<CloudQueue> listQueuesSegmented()
                                                                  throws StorageException

Gets a result segment of an iterable collection of queues for this Queue service client.

Returns:

A ResultSegment of CloudQueue objects that contains a segment of the iterable collection of CloudQueue objects that represent the requested queues in the storage service.

Throws:

StorageException - If a storage service error occurred during the operation.

listQueuesSegmented

@DoesServiceRequest
public ResultSegment<CloudQueue> listQueuesSegmented(String prefix)
                                                                  throws StorageException

Gets a result segment of an iterable collection of queues whose names begin with the specified prefix for this Queue service client.

Returns:

A ResultSegment of CloudQueue objects that contains a segment of the iterable collection of CloudQueue objects that represent the requested queues in the storage service.

Throws:

StorageException - If a storage service error occurred during the operation.

listQueuesSegmented

@DoesServiceRequest
public ResultSegment<CloudQueue> listQueuesSegmented(String prefix,
                                                                         QueueListingDetails detailsIncluded,
                                                                         Integer maxResults,
                                                                         ResultContinuation continuationToken,
                                                                         QueueRequestOptions options,
                                                                         OperationContext opContext)
                                                                  throws StorageException

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.

Parameters:

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 results to retrieve. If null or greater than 5000, the server will return up to 5,000 items. Must be at least 1.

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.

Returns:

A ResultSegment of CloudQueue objects that contains a segment of the iterable collection of CloudQueue objects that represent the requested queues in the storage service.

Throws:

StorageException - If a storage service error occurred during the operation.

getServiceStats

@DoesServiceRequest
public ServiceStats getServiceStats()
                                                 throws StorageException

Queries the service for the ServiceStats.

Returns:

ServiceStats for the given storage service

Throws:

StorageException - If a storage service error occurred.

getServiceStats

@DoesServiceRequest
public ServiceStats getServiceStats(QueueRequestOptions options,
                                                        OperationContext opContext)
                                                 throws StorageException

Queries the service for the ServiceStats.

Parameters:

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 ( CloudQueueClient).

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.

Returns:

ServiceStats for the given storage service

Throws:

StorageException - If a storage service error occurred.

downloadServiceProperties

@DoesServiceRequest
public final ServiceProperties downloadServiceProperties()
                                                                      throws StorageException

Retrieves the current ServiceProperties for the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Returns:

the ServiceProperties object representing the current configuration of the service.

Throws:

StorageException - If a storage service error occurred.

downloadServiceProperties

@DoesServiceRequest
public final ServiceProperties downloadServiceProperties(QueueRequestOptions options,
                                                                             OperationContext opContext)
                                                                      throws StorageException

Retrieves the current ServiceProperties for the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Parameters:

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 ( CloudQueueClient).

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.

Returns:

the ServiceProperties object representing the current configuration of the service.

Throws:

StorageException - If a storage service error occurred.

uploadServiceProperties

@DoesServiceRequest
public void uploadServiceProperties(ServiceProperties properties)
                                                 throws StorageException

Uploads a new ServiceProperties configuration to the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Parameters:

properties - The ServiceProperties to upload.

Throws:

StorageException - If a storage service error occurred.

uploadServiceProperties

@DoesServiceRequest
public void uploadServiceProperties(ServiceProperties properties,
                                                        QueueRequestOptions options,
                                                        OperationContext opContext)
                                                 throws StorageException

Uploads a new ServiceProperties configuration to the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.

Parameters:

properties - The ServiceProperties to upload.

options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).

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.

Throws:

StorageException - If a storage service error occurred.

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Overrides:

isUsePathStyleUris in class ServiceClient

Returns:

the usePathStyleUris

getDefaultRequestOptions

public QueueRequestOptions getDefaultRequestOptions()

Gets the QueueRequestOptions that is used for requests associated with this CloudQueueClient

Specified by:

getDefaultRequestOptions in class ServiceClient

Returns:

The QueueRequestOptions object containing the values used by this CloudQueueClient

setDefaultRequestOptions

public void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

Sets the QueueRequestOptions that is used for any queue accessed with this CloudQueueClient object.

Parameters:

defaultRequestOptions - The QueueRequestOptions to use.