Package | Description |
---|---|
com.microsoft.azure.storage.queue |
This package contains the storage service queue classes.
|
Modifier and Type | Method and Description |
---|---|
QueueRequestOptions |
CloudQueueClient.getDefaultRequestOptions()
Gets the
QueueRequestOptions that is used for requests associated with this CloudQueueClient |
protected static QueueRequestOptions |
QueueRequestOptions.populateAndApplyDefaults(QueueRequestOptions options,
CloudQueueClient client)
Populates the default timeout and retry policy from client if they are not set.
|
Modifier and Type | Method and Description |
---|---|
void |
CloudQueue.addMessage(CloudQueueMessage message,
int timeToLiveInSeconds,
int initialVisibilityDelayInSeconds,
QueueRequestOptions options,
OperationContext opContext)
Adds a message to the back of the queue with the specified options.
|
protected static void |
QueueRequestOptions.applyDefaults(QueueRequestOptions modifiedOptions)
Applies defaults to the options passed in.
|
void |
CloudQueue.clear(QueueRequestOptions options,
OperationContext opContext)
Clears all messages from the queue, using the specified request options and operation context.
|
void |
CloudQueue.create(QueueRequestOptions options,
OperationContext opContext)
Creates the queue, using the specified request options and operation context.
|
boolean |
CloudQueue.createIfNotExists(QueueRequestOptions options,
OperationContext opContext)
Creates the queue if it does not already exist, using the specified request options and operation context.
|
void |
CloudQueue.delete(QueueRequestOptions options,
OperationContext opContext)
Deletes the queue, using the specified request options and operation context.
|
boolean |
CloudQueue.deleteIfExists(QueueRequestOptions options,
OperationContext opContext)
Deletes the queue if it exists, using the specified request options and operation context.
|
void |
CloudQueue.deleteMessage(CloudQueueMessage message,
QueueRequestOptions options,
OperationContext opContext)
Deletes the specified message from the queue, using the specified request options and operation context.
|
void |
CloudQueue.downloadAttributes(QueueRequestOptions options,
OperationContext opContext)
Downloads the queue's metadata and approximate message count value, using the specified request options and
operation context.
|
QueuePermissions |
CloudQueue.downloadPermissions(QueueRequestOptions options,
OperationContext opContext)
Downloads the permissions settings for the queue using the specified request options and operation context.
|
ServiceProperties |
CloudQueueClient.downloadServiceProperties(QueueRequestOptions options,
OperationContext opContext)
Retrieves the current
ServiceProperties for the given storage service. |
boolean |
CloudQueue.exists(QueueRequestOptions options,
OperationContext opContext)
Returns a value that indicates whether the queue existse, using the specified request options and operation
context.
|
protected String |
CloudQueueMessage.getMessageContentForTransfer(boolean shouldEncodeMessage,
QueueRequestOptions options)
Gets the content of the message for transfer (internal use only).
|
ServiceStats |
CloudQueueClient.getServiceStats(QueueRequestOptions options,
OperationContext opContext)
Queries the service for the
ServiceStats . |
Iterable<CloudQueue> |
CloudQueueClient.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> |
CloudQueueClient.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.
|
CloudQueueMessage |
CloudQueue.peekMessage(QueueRequestOptions options,
OperationContext opContext)
Peeks a message from the queue, using the specified request options and operation context.
|
Iterable<CloudQueueMessage> |
CloudQueue.peekMessages(int numberOfMessages,
QueueRequestOptions options,
OperationContext opContext)
Peeks a set of messages from the queue, using the specified request options and operation context.
|
protected static QueueRequestOptions |
QueueRequestOptions.populateAndApplyDefaults(QueueRequestOptions options,
CloudQueueClient client)
Populates the default timeout and retry policy from client if they are not set.
|
CloudQueueMessage |
CloudQueue.retrieveMessage(int visibilityTimeoutInSeconds,
QueueRequestOptions options,
OperationContext opContext)
Retrieves a message from the front of the queue, using the specified request options and operation context.
|
Iterable<CloudQueueMessage> |
CloudQueue.retrieveMessages(int numberOfMessages,
int visibilityTimeoutInSeconds,
QueueRequestOptions options,
OperationContext opContext)
Retrieves the specified number of messages from the front of the queue using the specified request options and
operation context.
|
void |
CloudQueueClient.setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)
Sets the
QueueRequestOptions that is used for any queue accessed with this CloudQueueClient
object. |
void |
CloudQueue.updateMessage(CloudQueueMessage message,
int visibilityTimeoutInSeconds,
EnumSet<MessageUpdateFields> messageUpdateFields,
QueueRequestOptions options,
OperationContext opContext)
Updates a message in the queue, using the specified request options and operation context.
|
void |
CloudQueue.uploadMetadata(QueueRequestOptions options,
OperationContext opContext)
Uploads the metadata in the
CloudQueue object to the queue, using the specified request options and
operation context. |
void |
CloudQueue.uploadPermissions(QueuePermissions permissions,
QueueRequestOptions options,
OperationContext opContext)
Uploads the queue's permissions using the specified request options and operation context.
|
void |
CloudQueueClient.uploadServiceProperties(ServiceProperties properties,
QueueRequestOptions options,
OperationContext opContext)
Uploads a new
ServiceProperties configuration to the given storage service. |
Constructor and Description |
---|
QueueRequestOptions(QueueRequestOptions other)
Initializes a new instance of the QueueRequestOptions class as a copy of
another QueueRequestOptions instance.
|
Copyright © 2019. All rights reserved.