QueueClient (Azure SDK for Java Reference Documentation)

All Methods Instance Methods Concrete Methods Modifier and TypeMethod and DescriptionvoidclearMessages()

Deletes all messages in the queue.

com.azure.core.http.rest.Response<Void>clearMessagesWithResponse(Duration timeout, com.azure.core.util.Context context)

Deletes all messages in the queue.

voidcreate()

Creates a new queue.

com.azure.core.http.rest.Response<Void>createWithResponse(Map<String,String> metadata, Duration timeout, com.azure.core.util.Context context)

Creates a new queue.

voiddelete()

Permanently deletes the queue.

voiddeleteMessage(String messageId, String popReceipt)

Deletes the specified message in the queue

com.azure.core.http.rest.Response<Void>deleteMessageWithResponse(String messageId, String popReceipt, Duration timeout, com.azure.core.util.Context context)

Deletes the specified message in the queue

com.azure.core.http.rest.Response<Void>deleteWithResponse(Duration timeout, com.azure.core.util.Context context)

Permanently deletes the queue.

StringgenerateSas(QueueServiceSasSignatureValues queueServiceSasSignatureValues)com.azure.core.http.rest.PagedIterable<QueueSignedIdentifier>getAccessPolicy()

Retrieves stored access policies specified on the queue.

StringgetAccountName()

Get associated account name.

com.azure.core.http.HttpPipelinegetHttpPipeline()

Gets the HttpPipeline powering this client.

QueuePropertiesgetProperties()

Retrieves metadata and approximate message count of the queue.

com.azure.core.http.rest.Response<QueueProperties>getPropertiesWithResponse(Duration timeout, com.azure.core.util.Context context)

Retrieves metadata and approximate message count of the queue.

StringgetQueueName()

Get the queue name of the client.

StringgetQueueUrl() QueueServiceVersiongetServiceVersion()

Gets the service version the client is using.

PeekedMessageItempeekMessage()

Peeks the first message in the queue.

com.azure.core.http.rest.PagedIterable<PeekedMessageItem>peekMessages(Integer maxMessages, Duration timeout, com.azure.core.util.Context context)

Peek messages from the front of the queue up to the maximum number of messages.

QueueMessageItemreceiveMessage()

Retrieves the first message in the queue and hides it from other operations for 30 seconds.

com.azure.core.http.rest.PagedIterable<QueueMessageItem>receiveMessages(Integer maxMessages)

Retrieves up to the maximum number of messages from the queue and hides them from other operations for 30 seconds.

com.azure.core.http.rest.PagedIterable<QueueMessageItem>receiveMessages(Integer maxMessages, Duration visibilityTimeout, Duration timeout, com.azure.core.util.Context context)

Retrieves up to the maximum number of messages from the queue and hides them from other operations for the timeout period.

SendMessageResultsendMessage(String messageText)

Sends a message that has a time-to-live of 7 days and is instantly visible.

com.azure.core.http.rest.Response<SendMessageResult>sendMessageWithResponse(String messageText, Duration visibilityTimeout, Duration timeToLive, Duration timeout, com.azure.core.util.Context context)

Sends a message with a given time-to-live and a timeout period where the message is invisible in the queue.

voidsetAccessPolicy(List<QueueSignedIdentifier> permissions)

Sets stored access policies on the queue.

com.azure.core.http.rest.Response<Void>setAccessPolicyWithResponse(List<QueueSignedIdentifier> permissions, Duration timeout, com.azure.core.util.Context context)

Sets stored access policies on the queue.

voidsetMetadata(Map<String,String> metadata)

Sets the metadata of the queue.

com.azure.core.http.rest.Response<Void>setMetadataWithResponse(Map<String,String> metadata, Duration timeout, com.azure.core.util.Context context)

Sets the metadata of the queue.

UpdateMessageResultupdateMessage(String messageId, String popReceipt, String messageText, Duration visibilityTimeout)

Updates the specific message in the queue with a new message and resets the visibility timeout.

com.azure.core.http.rest.Response<UpdateMessageResult>updateMessageWithResponse(String messageId, String popReceipt, String messageText, Duration visibilityTimeout, Duration timeout, com.azure.core.util.Context context)

Updates the specific message in the queue with a new message and resets the visibility timeout.

ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnploopGrrnCt2a6pnmWjqbyzrcaeZKqtlaqycH2RZ2pnaF%2BYvK57wLOsq51fqMGwvsCgnGippZrCpnuwrpyunXOhtqa602efraWc