com.microsoft.azure.storage.queue

Class QueueURL

java.lang.Object

com.microsoft.azure.storage.queue.StorageURL

com.microsoft.azure.storage.queue.QueueURL

public final class QueueURL
extends StorageURL

Represents a URL to a queue. It may be obtained by direct construction or via the create method on a ServiceURL object. This class does not hold any state about messages in the queue but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to messages in the queue. Please refer to the Azure Docs for more information on queues.

Field Summary

Fields inherited from class com.microsoft.azure.storage.queue.StorageURL

storageClient

Constructor Summary

Constructors

Constructor and Description
QueueURL(URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<QueueCreateResponse>	create() Create a queue within a storage account.
io.reactivex.Single<QueueCreateResponse>	create(Metadata metadata, com.microsoft.rest.v2.Context context) Create a queue within a storage account.
MessagesURL	createMessagesUrl() createMessagesUrl creates a new MessagesURL object by concatenating "messages" to the end of QueueURL's URL.
io.reactivex.Single<QueueDeleteResponse>	delete() Delete permanently deletes a queue.
io.reactivex.Single<QueueDeleteResponse>	delete(com.microsoft.rest.v2.Context context) Delete permanently deletes a queue.
io.reactivex.Single<QueueGetAccessPolicyResponse>	getAccessPolicy() GetAccessPolicy returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
io.reactivex.Single<QueueGetAccessPolicyResponse>	getAccessPolicy(com.microsoft.rest.v2.Context context) GetAccessPolicy returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
io.reactivex.Single<QueueGetPropertiesResponse>	getProperties() GetProperties retrieves queue properties and user-defined metadata and properties on the specified queue.
io.reactivex.Single<QueueGetPropertiesResponse>	getProperties(com.microsoft.rest.v2.Context context) GetProperties retrieves queue properties and user-defined metadata and properties on the specified queue.
io.reactivex.Single<QueueSetAccessPolicyResponse>	setAccessPolicy(List<SignedIdentifier> identifiers) The Set Queue ACL operation sets stored access policies for the queue that may be used with Shared Access Signatures.
io.reactivex.Single<QueueSetAccessPolicyResponse>	setAccessPolicy(List<SignedIdentifier> identifiers, com.microsoft.rest.v2.Context context) The Set Queue ACL operation sets stored access policies for the queue that may be used with Shared Access Signatures.
io.reactivex.Single<QueueSetMetadataResponse>	setMetadata(Metadata metadata) SetMetadata sets user-defined metadata on the specified queue.
io.reactivex.Single<QueueSetMetadataResponse>	setMetadata(Metadata metadata, com.microsoft.rest.v2.Context context) SetMetadata sets user-defined metadata on the specified queue.
QueueURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new QueueURL with the given pipeline.

Methods inherited from class com.microsoft.azure.storage.queue.StorageURL

appendToURLPath, createPipeline, createPipeline, createPipeline, createPipeline, toString, toURL

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueURL

public QueueURL(URL url,
                com.microsoft.rest.v2.http.HttpPipeline pipeline)

Method Detail

withPipeline

public QueueURL withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a new QueueURL with the given pipeline.

Parameters:

pipeline - An HttpPipeline object to set.

Returns:

A QueueURL object with the given pipeline.

createMessagesUrl

public MessagesURL createMessagesUrl()

createMessagesUrl creates a new MessagesURL object by concatenating "messages" to the end of QueueURL's URL. The new MessagesURL uses the same request policy pipeline as the QueueURL. To change the pipeline, create the MessagesURL and then call its WithPipeline method passing in the desired pipeline object.

Returns:

A MessagesURL object with existing queue's pipeline.

create

public io.reactivex.Single<QueueCreateResponse> create()

Create a queue within a storage account. For more information, see the Azure Docs.

Returns:

Emits the successful response.

create

public io.reactivex.Single<QueueCreateResponse> create(Metadata metadata,
                                                       com.microsoft.rest.v2.Context context)

Create a queue within a storage account. For more information, see the Azure Docs.

Parameters:

metadata - Metadata

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

delete

public io.reactivex.Single<QueueDeleteResponse> delete()

Delete permanently deletes a queue. For more information, see the Azure Docs.

Returns:

Emits the successful response.

delete

public io.reactivex.Single<QueueDeleteResponse> delete(com.microsoft.rest.v2.Context context)

Delete permanently deletes a queue. For more information, see the Azure Docs.

Parameters:

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

getProperties

public io.reactivex.Single<QueueGetPropertiesResponse> getProperties()

GetProperties retrieves queue properties and user-defined metadata and properties on the specified queue. Metadata is associated with the queue as name-values pairs. For more information, see the Azure Docs.

Returns:

Emits the successful response.

getProperties

public io.reactivex.Single<QueueGetPropertiesResponse> getProperties(com.microsoft.rest.v2.Context context)

GetProperties retrieves queue properties and user-defined metadata and properties on the specified queue. Metadata is associated with the queue as name-values pairs. For more information, see the Azure Docs.

Parameters:

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

setMetadata

public io.reactivex.Single<QueueSetMetadataResponse> setMetadata(Metadata metadata)

SetMetadata sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. For more information, see the Azure Docs.

Parameters:

metadata - Metadata

Returns:

Emits the successful response.

setMetadata

public io.reactivex.Single<QueueSetMetadataResponse> setMetadata(Metadata metadata,
                                                                 com.microsoft.rest.v2.Context context)

SetMetadata sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. For more information, see the Azure Docs.

Parameters:

metadata - Metadata

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

getAccessPolicy

public io.reactivex.Single<QueueGetAccessPolicyResponse> getAccessPolicy()

GetAccessPolicy returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures. For more information, see the Azure Docs.

Returns:

Emits the successful response.

getAccessPolicy

public io.reactivex.Single<QueueGetAccessPolicyResponse> getAccessPolicy(com.microsoft.rest.v2.Context context)

GetAccessPolicy returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures. For more information, see the Azure Docs.

Parameters:

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

setAccessPolicy

public io.reactivex.Single<QueueSetAccessPolicyResponse> setAccessPolicy(List<SignedIdentifier> identifiers)

The Set Queue ACL operation sets stored access policies for the queue that may be used with Shared Access Signatures. Note that, for each signed identifier, we will truncate the start and expiry times to the nearest second to ensure the time formatting is compatible with the service. For more information, see the Azure Docs.

Parameters:

identifiers - A list of SignedIdentifier objects that specify the permissions for the queue. Please see here for more information. Passing null will clear all access policies.

Returns:

Emits the successful response.

setAccessPolicy

public io.reactivex.Single<QueueSetAccessPolicyResponse> setAccessPolicy(List<SignedIdentifier> identifiers,
                                                                         com.microsoft.rest.v2.Context context)

The Set Queue ACL operation sets stored access policies for the queue that may be used with Shared Access Signatures. Note that, for each signed identifier, we will truncate the start and expiry times to the nearest second to ensure the time formatting is compatible with the service. For more information, see the Azure Docs.

Parameters:

identifiers - A list of SignedIdentifier objects that specify the permissions for the queue. Please see here for more information. Passing null will clear all access policies.

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.