1647 строки
78 KiB
YAML
1647 строки
78 KiB
YAML
### YamlMime:ManagedReference
|
||
items:
|
||
- uid: com.microsoft.azure.servicebus._queue_client
|
||
id: _queue_client
|
||
parent: com.microsoft.azure.servicebus
|
||
children:
|
||
- com.microsoft.azure.servicebus._queue_client.abandon(UUID)
|
||
- com.microsoft.azure.servicebus._queue_client.abandon(UUID,Map<String, Object>)
|
||
- com.microsoft.azure.servicebus._queue_client.abandonAsync(UUID)
|
||
- com.microsoft.azure.servicebus._queue_client.abandonAsync(UUID,Map<String, Object>)
|
||
- com.microsoft.azure.servicebus._queue_client.cancelScheduledMessage(long)
|
||
- com.microsoft.azure.servicebus._queue_client.cancelScheduledMessageAsync(long)
|
||
- com.microsoft.azure.servicebus._queue_client.complete(UUID)
|
||
- com.microsoft.azure.servicebus._queue_client.completeAsync(UUID)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetter(UUID)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetter(UUID,Map<String, Object>)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetter(UUID,String,String)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetter(UUID,String,String,Map<String, Object>)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID,Map<String, Object>)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID,String,String)
|
||
- com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID,String,String,Map<String, Object>)
|
||
- com.microsoft.azure.servicebus._queue_client.getEntityPath()
|
||
- com.microsoft.azure.servicebus._queue_client.getPrefetchCount()
|
||
- com.microsoft.azure.servicebus._queue_client.getQueueName()
|
||
- com.microsoft.azure.servicebus._queue_client.getReceiveMode()
|
||
- com.microsoft.azure.servicebus._queue_client.onClose()
|
||
- com.microsoft.azure.servicebus._queue_client.QueueClient(ConnectionStringBuilder,ReceiveMode)
|
||
- com.microsoft.azure.servicebus._queue_client.QueueClient(String,String,ClientSettings,ReceiveMode)
|
||
- com.microsoft.azure.servicebus._queue_client.QueueClient(URI,String,ClientSettings,ReceiveMode)
|
||
- com.microsoft.azure.servicebus._queue_client.registerMessageHandler(IMessageHandler)
|
||
- com.microsoft.azure.servicebus._queue_client.registerMessageHandler(IMessageHandler,MessageHandlerOptions)
|
||
- com.microsoft.azure.servicebus._queue_client.registerSessionHandler(ISessionHandler)
|
||
- com.microsoft.azure.servicebus._queue_client.registerSessionHandler(ISessionHandler,SessionHandlerOptions)
|
||
- com.microsoft.azure.servicebus._queue_client.scheduleMessage(IMessage,Instant)
|
||
- com.microsoft.azure.servicebus._queue_client.scheduleMessageAsync(IMessage,Instant)
|
||
- com.microsoft.azure.servicebus._queue_client.send(IMessage)
|
||
- com.microsoft.azure.servicebus._queue_client.sendAsync(IMessage)
|
||
- com.microsoft.azure.servicebus._queue_client.sendBatch(Collection<? extends IMessage>)
|
||
- com.microsoft.azure.servicebus._queue_client.sendBatchAsync(Collection<? extends IMessage>)
|
||
- com.microsoft.azure.servicebus._queue_client.setPrefetchCount(int)
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: QueueClient
|
||
nameWithType: QueueClient
|
||
fullName: com.microsoft.azure.servicebus.QueueClient
|
||
type: Class
|
||
source:
|
||
remote: &o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
branch: master
|
||
repo: https://github.com/Azure/azure-service-bus-java
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 25
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public class QueueClient implements IQueueClient
|
||
inheritance:
|
||
- java.lang.Object
|
||
- com.microsoft.azure.servicebus.primitives._client_entity
|
||
- com.microsoft.azure.servicebus.InitializableEntity
|
||
inheritedMembers:
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.ClientEntity(final String)
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.close()
|
||
- com.microsoft.azure.servicebus._i_closeable.close()
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.closeAsync()
|
||
- com.microsoft.azure.servicebus._i_closeable.closeAsync()
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.finalize()
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.getClientId()
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.getIsClosed()
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.getIsClosingOrClosed()
|
||
- com.microsoft.azure.servicebus._initializable_entity.InitializableEntity(String)
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.setClosed()
|
||
- com.microsoft.azure.servicebus.primitives._client_entity.throwIfClosed(Throwable)
|
||
- uid: com.microsoft.azure.servicebus._queue_client.abandon(UUID)
|
||
id: abandon(UUID)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: abandon(UUID lockToken)
|
||
nameWithType: QueueClient.abandon(UUID lockToken)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.abandon(UUID lockToken)
|
||
overload: com.microsoft.azure.servicebus._queue_client.abandon*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 255
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void abandon(UUID lockToken)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- uid: com.microsoft.azure.servicebus._queue_client.abandon(UUID,Map<String, Object>)
|
||
id: abandon(UUID,Map<String, Object>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: abandon(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
nameWithType: QueueClient.abandon(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.abandon(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
overload: com.microsoft.azure.servicebus._queue_client.abandon*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 260
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void abandon(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: propertiesToModify
|
||
type: e7b06046
|
||
- uid: com.microsoft.azure.servicebus._queue_client.abandonAsync(UUID)
|
||
id: abandonAsync(UUID)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: abandonAsync(UUID lockToken)
|
||
nameWithType: QueueClient.abandonAsync(UUID lockToken)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.abandonAsync(UUID lockToken)
|
||
overload: com.microsoft.azure.servicebus._queue_client.abandonAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 265
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public CompletableFuture<Void> abandonAsync(UUID lockToken)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.abandonAsync(UUID,Map<String, Object>)
|
||
id: abandonAsync(UUID,Map<String, Object>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: abandonAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
nameWithType: QueueClient.abandonAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.abandonAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
overload: com.microsoft.azure.servicebus._queue_client.abandonAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 270
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public CompletableFuture<Void> abandonAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: propertiesToModify
|
||
type: e7b06046
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.cancelScheduledMessage(long)
|
||
id: cancelScheduledMessage(long)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: cancelScheduledMessage(long sequenceNumber)
|
||
nameWithType: QueueClient.cancelScheduledMessage(long sequenceNumber)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.cancelScheduledMessage(long sequenceNumber)
|
||
overload: com.microsoft.azure.servicebus._queue_client.cancelScheduledMessage*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 194
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Cancels the enqueuing of an already sent scheduled message, if it was not already enqueued. This method blocks until the message is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void cancelScheduledMessage(long sequenceNumber)
|
||
parameters:
|
||
- id: sequenceNumber
|
||
type: 0364520f
|
||
description: <p>sequence number of the scheduled message </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.cancelScheduledMessage(long)
|
||
exceptions:
|
||
- type: 8256ba40
|
||
description: <p>if the current thread was interrupted while waiting </p>
|
||
- type: 73fec9fb
|
||
description: <p>if scheduled message couldn't be cancelled </p>
|
||
- uid: com.microsoft.azure.servicebus._queue_client.cancelScheduledMessageAsync(long)
|
||
id: cancelScheduledMessageAsync(long)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: cancelScheduledMessageAsync(long sequenceNumber)
|
||
nameWithType: QueueClient.cancelScheduledMessageAsync(long sequenceNumber)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.cancelScheduledMessageAsync(long sequenceNumber)
|
||
overload: com.microsoft.azure.servicebus._queue_client.cancelScheduledMessageAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 181
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Cancels the enqueuing of an already sent scheduled message, if it was not already enqueued. This is an asynchronous method returning a CompletableFuture which completes when the message is cancelled.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Void> cancelScheduledMessageAsync(long sequenceNumber)
|
||
parameters:
|
||
- id: sequenceNumber
|
||
type: 0364520f
|
||
description: <p>sequence number of the scheduled message </p>
|
||
return:
|
||
type: db03ee24
|
||
description: <p>a CompletableFuture representing the pending cancellation </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.cancelScheduledMessageAsync(long)
|
||
- uid: com.microsoft.azure.servicebus._queue_client.complete(UUID)
|
||
id: complete(UUID)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: complete(UUID lockToken)
|
||
nameWithType: QueueClient.complete(UUID lockToken)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.complete(UUID lockToken)
|
||
overload: com.microsoft.azure.servicebus._queue_client.complete*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 275
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void complete(UUID lockToken)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- uid: com.microsoft.azure.servicebus._queue_client.completeAsync(UUID)
|
||
id: completeAsync(UUID)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: completeAsync(UUID lockToken)
|
||
nameWithType: QueueClient.completeAsync(UUID lockToken)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.completeAsync(UUID lockToken)
|
||
overload: com.microsoft.azure.servicebus._queue_client.completeAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 280
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public CompletableFuture<Void> completeAsync(UUID lockToken)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetter(UUID)
|
||
id: deadLetter(UUID)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetter(UUID lockToken)
|
||
nameWithType: QueueClient.deadLetter(UUID lockToken)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetter(UUID lockToken)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetter*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 305
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void deadLetter(UUID lockToken)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetter(UUID,Map<String, Object>)
|
||
id: deadLetter(UUID,Map<String, Object>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetter(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
nameWithType: QueueClient.deadLetter(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetter(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetter*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 310
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void deadLetter(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: propertiesToModify
|
||
type: e7b06046
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetter(UUID,String,String)
|
||
id: deadLetter(UUID,String,String)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
nameWithType: QueueClient.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetter*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 315
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: deadLetterReason
|
||
type: "26831127"
|
||
- id: deadLetterErrorDescription
|
||
type: "26831127"
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetter(UUID,String,String,Map<String, Object>)
|
||
id: deadLetter(UUID,String,String,Map<String, Object>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
nameWithType: QueueClient.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetter*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 320
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: deadLetterReason
|
||
type: "26831127"
|
||
- id: deadLetterErrorDescription
|
||
type: "26831127"
|
||
- id: propertiesToModify
|
||
type: e7b06046
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID)
|
||
id: deadLetterAsync(UUID)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetterAsync(UUID lockToken)
|
||
nameWithType: QueueClient.deadLetterAsync(UUID lockToken)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetterAsync(UUID lockToken)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetterAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 325
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public CompletableFuture<Void> deadLetterAsync(UUID lockToken)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID,Map<String, Object>)
|
||
id: deadLetterAsync(UUID,Map<String, Object>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetterAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
nameWithType: QueueClient.deadLetterAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetterAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetterAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 330
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public CompletableFuture<Void> deadLetterAsync(UUID lockToken, Map<String, Object> propertiesToModify)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: propertiesToModify
|
||
type: e7b06046
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID,String,String)
|
||
id: deadLetterAsync(UUID,String,String)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
nameWithType: QueueClient.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetterAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 335
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public CompletableFuture<Void> deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: deadLetterReason
|
||
type: "26831127"
|
||
- id: deadLetterErrorDescription
|
||
type: "26831127"
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetterAsync(UUID,String,String,Map<String, Object>)
|
||
id: deadLetterAsync(UUID,String,String,Map<String, Object>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
nameWithType: QueueClient.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
overload: com.microsoft.azure.servicebus._queue_client.deadLetterAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 340
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public CompletableFuture<Void> deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String, Object> propertiesToModify)
|
||
parameters:
|
||
- id: lockToken
|
||
type: add9545a
|
||
- id: deadLetterReason
|
||
type: "26831127"
|
||
- id: deadLetterErrorDescription
|
||
type: "26831127"
|
||
- id: propertiesToModify
|
||
type: e7b06046
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getEntityPath()
|
||
id: getEntityPath()
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: getEntityPath()
|
||
nameWithType: QueueClient.getEntityPath()
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getEntityPath()
|
||
overload: com.microsoft.azure.servicebus._queue_client.getEntityPath*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 199
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Gets the path of the entity this client is sending messages to or receiving messages from.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String getEntityPath()
|
||
return:
|
||
type: "26831127"
|
||
description: <p>path of the entity this client is connecting to </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_entity_client.getEntityPath()
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getPrefetchCount()
|
||
id: getPrefetchCount()
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: getPrefetchCount()
|
||
nameWithType: QueueClient.getPrefetchCount()
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getPrefetchCount()
|
||
overload: com.microsoft.azure.servicebus._queue_client.getPrefetchCount*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 345
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public int getPrefetchCount()
|
||
return:
|
||
type: f75371fa
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getQueueName()
|
||
id: getQueueName()
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: getQueueName()
|
||
nameWithType: QueueClient.getQueueName()
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getQueueName()
|
||
overload: com.microsoft.azure.servicebus._queue_client.getQueueName*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 355
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Gets the name of the queue.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String getQueueName()
|
||
return:
|
||
type: "26831127"
|
||
description: <p>The name of the queue. </p>
|
||
overridden: com.microsoft.azure.servicebus._i_queue_client.getQueueName()
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getReceiveMode()
|
||
id: getReceiveMode()
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: getReceiveMode()
|
||
nameWithType: QueueClient.getReceiveMode()
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getReceiveMode()
|
||
overload: com.microsoft.azure.servicebus._queue_client.getReceiveMode*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 142
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Gets the <xref uid="com.microsoft.azure.servicebus._receive_mode" data-throw-if-not-resolved="false">ReceiveMode</xref> of the current receiver</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public ReceiveMode getReceiveMode()
|
||
return:
|
||
type: com.microsoft.azure.servicebus._receive_mode
|
||
description: <p>The receive mode. </p>
|
||
overridden: com.microsoft.azure.servicebus._i_queue_client.getReceiveMode()
|
||
- uid: com.microsoft.azure.servicebus._queue_client.onClose()
|
||
id: onClose()
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: onClose()
|
||
nameWithType: QueueClient.onClose()
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.onClose()
|
||
overload: com.microsoft.azure.servicebus._queue_client.onClose*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 230
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: protected CompletableFuture<Void> onClose()
|
||
return:
|
||
type: db03ee24
|
||
- uid: com.microsoft.azure.servicebus._queue_client.QueueClient(ConnectionStringBuilder,ReceiveMode)
|
||
id: QueueClient(ConnectionStringBuilder,ReceiveMode)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: QueueClient(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)
|
||
nameWithType: QueueClient.QueueClient(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.QueueClient(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)
|
||
overload: com.microsoft.azure.servicebus._queue_client.QueueClient*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 45
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public QueueClient(ConnectionStringBuilder amqpConnectionStringBuilder, ReceiveMode receiveMode)
|
||
parameters:
|
||
- id: amqpConnectionStringBuilder
|
||
type: com.microsoft.azure.servicebus.primitives._connection_string_builder
|
||
- id: receiveMode
|
||
type: com.microsoft.azure.servicebus._receive_mode
|
||
- uid: com.microsoft.azure.servicebus._queue_client.QueueClient(String,String,ClientSettings,ReceiveMode)
|
||
id: QueueClient(String,String,ClientSettings,ReceiveMode)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: QueueClient(String namespace, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
nameWithType: QueueClient.QueueClient(String namespace, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.QueueClient(String namespace, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
overload: com.microsoft.azure.servicebus._queue_client.QueueClient*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 54
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public QueueClient(String namespace, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
parameters:
|
||
- id: namespace
|
||
type: "26831127"
|
||
- id: queuePath
|
||
type: "26831127"
|
||
- id: clientSettings
|
||
type: com.microsoft.azure.servicebus._client_settings
|
||
- id: receiveMode
|
||
type: com.microsoft.azure.servicebus._receive_mode
|
||
- uid: com.microsoft.azure.servicebus._queue_client.QueueClient(URI,String,ClientSettings,ReceiveMode)
|
||
id: QueueClient(URI,String,ClientSettings,ReceiveMode)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: QueueClient(URI namespaceEndpointURI, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
nameWithType: QueueClient.QueueClient(URI namespaceEndpointURI, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.QueueClient(URI namespaceEndpointURI, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
overload: com.microsoft.azure.servicebus._queue_client.QueueClient*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 59
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public QueueClient(URI namespaceEndpointURI, String queuePath, ClientSettings clientSettings, ReceiveMode receiveMode)
|
||
parameters:
|
||
- id: namespaceEndpointURI
|
||
type: "62304784"
|
||
- id: queuePath
|
||
type: "26831127"
|
||
- id: clientSettings
|
||
type: com.microsoft.azure.servicebus._client_settings
|
||
- id: receiveMode
|
||
type: com.microsoft.azure.servicebus._receive_mode
|
||
- uid: com.microsoft.azure.servicebus._queue_client.registerMessageHandler(IMessageHandler)
|
||
id: registerMessageHandler(IMessageHandler)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: registerMessageHandler(IMessageHandler handler)
|
||
nameWithType: QueueClient.registerMessageHandler(IMessageHandler handler)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.registerMessageHandler(IMessageHandler handler)
|
||
overload: com.microsoft.azure.servicebus._queue_client.registerMessageHandler*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 204
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void registerMessageHandler(IMessageHandler handler)
|
||
parameters:
|
||
- id: handler
|
||
type: com.microsoft.azure.servicebus._i_message_handler
|
||
- uid: com.microsoft.azure.servicebus._queue_client.registerMessageHandler(IMessageHandler,MessageHandlerOptions)
|
||
id: registerMessageHandler(IMessageHandler,MessageHandlerOptions)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)
|
||
nameWithType: QueueClient.registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)
|
||
overload: com.microsoft.azure.servicebus._queue_client.registerMessageHandler*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 209
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)
|
||
parameters:
|
||
- id: handler
|
||
type: com.microsoft.azure.servicebus._i_message_handler
|
||
- id: handlerOptions
|
||
type: com.microsoft.azure.servicebus._message_handler_options
|
||
- uid: com.microsoft.azure.servicebus._queue_client.registerSessionHandler(ISessionHandler)
|
||
id: registerSessionHandler(ISessionHandler)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: registerSessionHandler(ISessionHandler handler)
|
||
nameWithType: QueueClient.registerSessionHandler(ISessionHandler handler)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.registerSessionHandler(ISessionHandler handler)
|
||
overload: com.microsoft.azure.servicebus._queue_client.registerSessionHandler*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 214
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void registerSessionHandler(ISessionHandler handler)
|
||
parameters:
|
||
- id: handler
|
||
type: com.microsoft.azure.servicebus._i_session_handler
|
||
- uid: com.microsoft.azure.servicebus._queue_client.registerSessionHandler(ISessionHandler,SessionHandlerOptions)
|
||
id: registerSessionHandler(ISessionHandler,SessionHandlerOptions)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)
|
||
nameWithType: QueueClient.registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)
|
||
overload: com.microsoft.azure.servicebus._queue_client.registerSessionHandler*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 219
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)
|
||
parameters:
|
||
- id: handler
|
||
type: com.microsoft.azure.servicebus._i_session_handler
|
||
- id: handlerOptions
|
||
type: com.microsoft.azure.servicebus._session_handler_options
|
||
- uid: com.microsoft.azure.servicebus._queue_client.scheduleMessage(IMessage,Instant)
|
||
id: scheduleMessage(IMessage,Instant)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
nameWithType: QueueClient.scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
overload: com.microsoft.azure.servicebus._queue_client.scheduleMessage*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 189
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Sends a scheduled message to the Azure Service Bus entity this sender is connected to. A scheduled message is enqueued and made available to receivers only at the scheduled enqueue time. This method blocks until the message is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public long scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
- id: scheduledEnqueueTimeUtc
|
||
type: 328f8254
|
||
description: <p>instant at which the message should be enqueued in the entity </p>
|
||
return:
|
||
type: 0364520f
|
||
description: <p>sequence number of the scheduled message </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.scheduleMessage(IMessage,Instant)
|
||
exceptions:
|
||
- type: 8256ba40
|
||
description: <p>if the current thread was interrupted while waiting </p>
|
||
- type: 73fec9fb
|
||
description: <p>if message couldn't be sent to the entity </p>
|
||
- uid: com.microsoft.azure.servicebus._queue_client.scheduleMessageAsync(IMessage,Instant)
|
||
id: scheduleMessageAsync(IMessage,Instant)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
nameWithType: QueueClient.scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
overload: com.microsoft.azure.servicebus._queue_client.scheduleMessageAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 173
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Sends a scheduled message to the Azure Service Bus entity this sender is connected to. A scheduled message is enqueued and made available to receivers only at the scheduled enqueue time. This is an asynchronous method returning a CompletableFuture which completes when the message is sent to the entity. The CompletableFuture, on completion, returns the sequence number of the scheduled message which can be used to cancel the scheduling of the message.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Long> scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
- id: scheduledEnqueueTimeUtc
|
||
type: 328f8254
|
||
description: <p>instant at which the message should be enqueued in the entity </p>
|
||
return:
|
||
type: 30822cb1
|
||
description: <p>a CompletableFuture representing the pending send, which returns the sequence number of the scheduled message. This sequence number can be used to cancel the scheduling of the message. </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.scheduleMessageAsync(IMessage,Instant)
|
||
- uid: com.microsoft.azure.servicebus._queue_client.send(IMessage)
|
||
id: send(IMessage)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: send(IMessage message)
|
||
nameWithType: QueueClient.send(IMessage message)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.send(IMessage message)
|
||
overload: com.microsoft.azure.servicebus._queue_client.send*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 147
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Sends a message to the Azure Service Bus entity this sender is connected to. This method blocks until the message is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void send(IMessage message)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.send(IMessage)
|
||
exceptions:
|
||
- type: 8256ba40
|
||
description: <p>if the current thread was interrupted while waiting </p>
|
||
- type: 73fec9fb
|
||
description: <p>if message couldn't be sent to the entity </p>
|
||
- uid: com.microsoft.azure.servicebus._queue_client.sendAsync(IMessage)
|
||
id: sendAsync(IMessage)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: sendAsync(IMessage message)
|
||
nameWithType: QueueClient.sendAsync(IMessage message)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.sendAsync(IMessage message)
|
||
overload: com.microsoft.azure.servicebus._queue_client.sendAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 157
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Sends a message to the Azure Service Bus entity this sender is connected to. This is an asynchronous method returning a CompletableFuture which completes when the message is sent to the entity.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Void> sendAsync(IMessage message)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
return:
|
||
type: db03ee24
|
||
description: <p>a CompletableFuture representing the pending send </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.sendAsync(IMessage)
|
||
- uid: com.microsoft.azure.servicebus._queue_client.sendBatch(Collection<? extends IMessage>)
|
||
id: sendBatch(Collection<? extends IMessage>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: sendBatch(Collection<? extends IMessage> messages)
|
||
nameWithType: QueueClient.sendBatch(Collection<? extends IMessage> messages)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.sendBatch(Collection<? extends IMessage> messages)
|
||
overload: com.microsoft.azure.servicebus._queue_client.sendBatch*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 152
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Sends a batch of messages to the Azure Service Bus entity this sender is connected to. This method blocks until the batch is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void sendBatch(Collection<? extends IMessage> messages)
|
||
parameters:
|
||
- id: messages
|
||
type: d56263b8com.microsoft.azure.servicebus._i_messagea08ddfce
|
||
description: <p>collection of messages to be sent to the entity </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.sendBatch(Collection<? extends IMessage>)
|
||
exceptions:
|
||
- type: 8256ba40
|
||
description: <p>if the current thread was interrupted while waiting </p>
|
||
- type: 73fec9fb
|
||
description: <p>if the batch couldn't be sent to the entity </p>
|
||
- uid: com.microsoft.azure.servicebus._queue_client.sendBatchAsync(Collection<? extends IMessage>)
|
||
id: sendBatchAsync(Collection<? extends IMessage>)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: sendBatchAsync(Collection<? extends IMessage> messages)
|
||
nameWithType: QueueClient.sendBatchAsync(Collection<? extends IMessage> messages)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.sendBatchAsync(Collection<? extends IMessage> messages)
|
||
overload: com.microsoft.azure.servicebus._queue_client.sendBatchAsync*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 165
|
||
package: com.microsoft.azure.servicebus
|
||
summary: >-
|
||
<p>Sends a batch of messages to the Azure Service Bus entity this sender is connected to. This is an asynchronous method returning a CompletableFuture which completes when the batch is sent to the entity.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Void> sendBatchAsync(Collection<? extends IMessage> messages)
|
||
parameters:
|
||
- id: messages
|
||
type: d56263b8com.microsoft.azure.servicebus._i_messagea08ddfce
|
||
description: <p>collection of messages to be sent to the entity </p>
|
||
return:
|
||
type: db03ee24
|
||
description: <p>a CompletableFuture representing the pending send </p>
|
||
overridden: com.microsoft.azure.servicebus._i_message_sender.sendBatchAsync(Collection<? extends IMessage>)
|
||
- uid: com.microsoft.azure.servicebus._queue_client.setPrefetchCount(int)
|
||
id: setPrefetchCount(int)
|
||
parent: com.microsoft.azure.servicebus._queue_client
|
||
href: com.microsoft.azure.servicebus._queue_client.yml
|
||
langs:
|
||
- java
|
||
name: setPrefetchCount(int prefetchCount)
|
||
nameWithType: QueueClient.setPrefetchCount(int prefetchCount)
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.setPrefetchCount(int prefetchCount)
|
||
overload: com.microsoft.azure.servicebus._queue_client.setPrefetchCount*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: azure-servicebus/src/main/java/com/microsoft/azure/servicebus/QueueClient.java
|
||
startLine: 350
|
||
package: com.microsoft.azure.servicebus
|
||
syntax:
|
||
content: public void setPrefetchCount(int prefetchCount)
|
||
parameters:
|
||
- id: prefetchCount
|
||
type: f75371fa
|
||
references:
|
||
- uid: com.microsoft.azure.servicebus._queue_client.QueueClient*
|
||
name: QueueClient
|
||
nameWithType: QueueClient.QueueClient
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.QueueClient
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: "26831127"
|
||
spec.java:
|
||
- name: String
|
||
fullName: String
|
||
- uid: "62304784"
|
||
spec.java:
|
||
- name: URI
|
||
fullName: URI
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getReceiveMode*
|
||
name: getReceiveMode
|
||
nameWithType: QueueClient.getReceiveMode
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getReceiveMode
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: 8256ba40
|
||
spec.java:
|
||
- name: InterruptedException
|
||
fullName: InterruptedException
|
||
- uid: 73fec9fb
|
||
spec.java:
|
||
- name: ServiceBusException
|
||
fullName: ServiceBusException
|
||
- uid: com.microsoft.azure.servicebus._queue_client.send*
|
||
name: send
|
||
nameWithType: QueueClient.send
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.send
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: d56263b8com.microsoft.azure.servicebus._i_messagea08ddfce
|
||
spec.java:
|
||
- name: 'Collection<? extends '
|
||
fullName: 'Collection<? extends '
|
||
- uid: com.microsoft.azure.servicebus._i_message
|
||
name: IMessage
|
||
fullName: com.microsoft.azure.servicebus.IMessage
|
||
href: com.microsoft.azure.servicebus._i_message.yml
|
||
- name: '>'
|
||
fullName: '>'
|
||
- uid: com.microsoft.azure.servicebus._queue_client.sendBatch*
|
||
name: sendBatch
|
||
nameWithType: QueueClient.sendBatch
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.sendBatch
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: db03ee24
|
||
spec.java:
|
||
- name: CompletableFuture<Void>
|
||
fullName: CompletableFuture<Void>
|
||
- uid: com.microsoft.azure.servicebus._queue_client.sendAsync*
|
||
name: sendAsync
|
||
nameWithType: QueueClient.sendAsync
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.sendAsync
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.sendBatchAsync*
|
||
name: sendBatchAsync
|
||
nameWithType: QueueClient.sendBatchAsync
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.sendBatchAsync
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: 328f8254
|
||
spec.java:
|
||
- name: Instant
|
||
fullName: Instant
|
||
- uid: 30822cb1
|
||
spec.java:
|
||
- name: CompletableFuture<Long>
|
||
fullName: CompletableFuture<Long>
|
||
- uid: com.microsoft.azure.servicebus._queue_client.scheduleMessageAsync*
|
||
name: scheduleMessageAsync
|
||
nameWithType: QueueClient.scheduleMessageAsync
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.scheduleMessageAsync
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: 0364520f
|
||
spec.java:
|
||
- name: long
|
||
fullName: long
|
||
- uid: com.microsoft.azure.servicebus._queue_client.cancelScheduledMessageAsync*
|
||
name: cancelScheduledMessageAsync
|
||
nameWithType: QueueClient.cancelScheduledMessageAsync
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.cancelScheduledMessageAsync
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.scheduleMessage*
|
||
name: scheduleMessage
|
||
nameWithType: QueueClient.scheduleMessage
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.scheduleMessage
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.cancelScheduledMessage*
|
||
name: cancelScheduledMessage
|
||
nameWithType: QueueClient.cancelScheduledMessage
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.cancelScheduledMessage
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getEntityPath*
|
||
name: getEntityPath
|
||
nameWithType: QueueClient.getEntityPath
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getEntityPath
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.registerMessageHandler*
|
||
name: registerMessageHandler
|
||
nameWithType: QueueClient.registerMessageHandler
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.registerMessageHandler
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.registerSessionHandler*
|
||
name: registerSessionHandler
|
||
nameWithType: QueueClient.registerSessionHandler
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.registerSessionHandler
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: add9545a
|
||
spec.java:
|
||
- name: UUID
|
||
fullName: UUID
|
||
- uid: com.microsoft.azure.servicebus._queue_client.abandon*
|
||
name: abandon
|
||
nameWithType: QueueClient.abandon
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.abandon
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: e7b06046
|
||
spec.java:
|
||
- name: Map<String, Object>
|
||
fullName: Map<String, Object>
|
||
- uid: com.microsoft.azure.servicebus._queue_client.abandonAsync*
|
||
name: abandonAsync
|
||
nameWithType: QueueClient.abandonAsync
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.abandonAsync
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.complete*
|
||
name: complete
|
||
nameWithType: QueueClient.complete
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.complete
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.completeAsync*
|
||
name: completeAsync
|
||
nameWithType: QueueClient.completeAsync
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.completeAsync
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetter*
|
||
name: deadLetter
|
||
nameWithType: QueueClient.deadLetter
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetter
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.deadLetterAsync*
|
||
name: deadLetterAsync
|
||
nameWithType: QueueClient.deadLetterAsync
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.deadLetterAsync
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: f75371fa
|
||
spec.java:
|
||
- name: int
|
||
fullName: int
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getPrefetchCount*
|
||
name: getPrefetchCount
|
||
nameWithType: QueueClient.getPrefetchCount
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getPrefetchCount
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.setPrefetchCount*
|
||
name: setPrefetchCount
|
||
nameWithType: QueueClient.setPrefetchCount
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.setPrefetchCount
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.getQueueName*
|
||
name: getQueueName
|
||
nameWithType: QueueClient.getQueueName
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.getQueueName
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus._queue_client.onClose*
|
||
name: onClose
|
||
nameWithType: QueueClient.onClose
|
||
fullName: com.microsoft.azure.servicebus.QueueClient.onClose
|
||
package: com.microsoft.azure.servicebus
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.ClientEntity(final String)
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: ClientEntity(final String clientId)
|
||
nameWithType: ClientEntity.ClientEntity(final String clientId)
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.ClientEntity(final String clientId)
|
||
type: Constructor
|
||
syntax:
|
||
content: protected ClientEntity(final String clientId)
|
||
parameters:
|
||
- id: clientId
|
||
type: 3d93591e
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.close()
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: close()
|
||
nameWithType: ClientEntity.close()
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.close()
|
||
type: Method
|
||
syntax:
|
||
content: public final void close()
|
||
return:
|
||
type: 3f6357ce
|
||
- uid: com.microsoft.azure.servicebus._i_closeable.close()
|
||
parent: com.microsoft.azure.servicebus._i_closeable
|
||
href: com.microsoft.azure.servicebus._i_closeable.yml
|
||
name: close()
|
||
nameWithType: ICloseable.close()
|
||
fullName: com.microsoft.azure.servicebus.ICloseable.close()
|
||
type: Method
|
||
summary: <p>Synchronously closes and disposes any resources associated with this object. Calling this method is equivalent of calling . This method blocks until this object is closed. </p>
|
||
syntax:
|
||
content: public void close()
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.closeAsync()
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: closeAsync()
|
||
nameWithType: ClientEntity.closeAsync()
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.closeAsync()
|
||
type: Method
|
||
syntax:
|
||
content: public final CompletableFuture<Void> closeAsync()
|
||
return:
|
||
type: fc984e6f
|
||
- uid: com.microsoft.azure.servicebus._i_closeable.closeAsync()
|
||
parent: com.microsoft.azure.servicebus._i_closeable
|
||
href: com.microsoft.azure.servicebus._i_closeable.yml
|
||
name: closeAsync()
|
||
nameWithType: ICloseable.closeAsync()
|
||
fullName: com.microsoft.azure.servicebus.ICloseable.closeAsync()
|
||
type: Method
|
||
summary: <p>Closes and disposes any resources associated with this object. An object cannot be used after it is closed. This is an asynchronous method that returns a CompletableFuture immediately. This object is completely closed when the returned CompletableFuture is completed. </p>
|
||
syntax:
|
||
content: public CompletableFuture<Void> closeAsync()
|
||
return:
|
||
type: db03ee24
|
||
description: <p>a CompletableFuture representing the closing of this object. </p>
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.finalize()
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: finalize()
|
||
nameWithType: ClientEntity.finalize()
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.finalize()
|
||
type: Method
|
||
syntax:
|
||
content: protected void finalize()
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.getClientId()
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: getClientId()
|
||
nameWithType: ClientEntity.getClientId()
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.getClientId()
|
||
type: Method
|
||
syntax:
|
||
content: public String getClientId()
|
||
return:
|
||
type: "26831127"
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.getIsClosed()
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: getIsClosed()
|
||
nameWithType: ClientEntity.getIsClosed()
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.getIsClosed()
|
||
type: Method
|
||
syntax:
|
||
content: protected boolean getIsClosed()
|
||
return:
|
||
type: 4fc6e284
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.getIsClosingOrClosed()
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: getIsClosingOrClosed()
|
||
nameWithType: ClientEntity.getIsClosingOrClosed()
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.getIsClosingOrClosed()
|
||
type: Method
|
||
syntax:
|
||
content: protected boolean getIsClosingOrClosed()
|
||
return:
|
||
type: 4fc6e284
|
||
- uid: com.microsoft.azure.servicebus._initializable_entity.InitializableEntity(String)
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.setClosed()
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: setClosed()
|
||
nameWithType: ClientEntity.setClosed()
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.setClosed()
|
||
type: Method
|
||
syntax:
|
||
content: protected final void setClosed()
|
||
return:
|
||
type: 3f6357ce
|
||
- uid: com.microsoft.azure.servicebus.primitives._client_entity.throwIfClosed(Throwable)
|
||
parent: com.microsoft.azure.servicebus.primitives._client_entity
|
||
href: com.microsoft.azure.servicebus.primitives._client_entity.yml
|
||
name: throwIfClosed(Throwable cause)
|
||
nameWithType: ClientEntity.throwIfClosed(Throwable cause)
|
||
fullName: com.microsoft.azure.servicebus.primitives.ClientEntity.throwIfClosed(Throwable cause)
|
||
type: Method
|
||
syntax:
|
||
content: protected final void throwIfClosed(Throwable cause)
|
||
parameters:
|
||
- id: cause
|
||
type: a04fafd7
|
||
return:
|
||
type: 3f6357ce
|
||
- uid: com.microsoft.azure.servicebus._i_queue_client
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._i_queue_client.yml
|
||
name: IQueueClient
|
||
nameWithType: IQueueClient
|
||
fullName: com.microsoft.azure.servicebus.IQueueClient
|
||
type: Interface
|
||
summary: <p>QueueClient can be used for all basic interactions with a Service Bus Queue. </p>
|
||
syntax:
|
||
content: public interface IQueueClient extends IMessageSender,IMessageEntityClient
|
||
- uid: com.microsoft.azure.servicebus._receive_mode
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._receive_mode.yml
|
||
name: ReceiveMode
|
||
nameWithType: ReceiveMode
|
||
fullName: com.microsoft.azure.servicebus.ReceiveMode
|
||
type: Enum
|
||
summary: >-
|
||
<p>Enumeration to represent the two receive modes Azure Service Bus supports.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public enum ReceiveMode
|
||
- uid: com.microsoft.azure.servicebus.primitives._messaging_factory
|
||
parent: com.microsoft.azure.servicebus.primitives
|
||
href: com.microsoft.azure.servicebus.primitives._messaging_factory.yml
|
||
name: MessagingFactory
|
||
nameWithType: MessagingFactory
|
||
fullName: com.microsoft.azure.servicebus.primitives.MessagingFactory
|
||
type: Class
|
||
summary: <p>Abstracts all AMQP related details and encapsulates an AMQP connection and manages its life cycle. Each instance of this class represent one AMQP connection to the namespace. If an application creates multiple senders, receivers or clients using the same MessagingFacotry instance, all those senders, receivers or clients will share the same connection to the namespace. </p>
|
||
syntax:
|
||
content: public class MessagingFactory extends ClientEntity
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: IMessageSender
|
||
nameWithType: IMessageSender
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender
|
||
type: Interface
|
||
summary: >-
|
||
<p>Represents a message sender that sends messages to Azure Service Bus.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public interface IMessageSender extends IMessageEntityClient
|
||
- uid: com.microsoft.azure.servicebus.primitives._misc_request_response_operation_handler
|
||
parent: com.microsoft.azure.servicebus.primitives
|
||
href: com.microsoft.azure.servicebus.primitives._misc_request_response_operation_handler.yml
|
||
name: MiscRequestResponseOperationHandler
|
||
nameWithType: MiscRequestResponseOperationHandler
|
||
fullName: com.microsoft.azure.servicebus.primitives.MiscRequestResponseOperationHandler
|
||
type: Class
|
||
syntax:
|
||
content: public class MiscRequestResponseOperationHandler extends ClientEntity
|
||
- uid: com.microsoft.azure.servicebus.primitives._connection_string_builder
|
||
parent: com.microsoft.azure.servicebus.primitives
|
||
href: com.microsoft.azure.servicebus.primitives._connection_string_builder.yml
|
||
name: ConnectionStringBuilder
|
||
nameWithType: ConnectionStringBuilder
|
||
fullName: com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder
|
||
type: Class
|
||
summary: >-
|
||
<p>This class can be used to construct a connection string which can establish communication with ServiceBus entities. It can also be used to perform basic validation on an existing connection string. </p>
|
||
|
||
<p>Sample Code: <pre><code>ConnectionStringBuilder connectionStringBuilder = new ConnectionStringBuilder(
|
||
|
||
"ServiceBusNamespaceName",
|
||
|
||
"ServiceBusEntityName", // QueueName or TopicName or SubscriptionPath
|
||
|
||
"SharedAccessSignatureKeyName",
|
||
|
||
"SharedAccessSignatureKey");
|
||
|
||
|
||
|
||
String connectionString = connectionStringBuilder.toString();
|
||
|
||
</code></pre></p>
|
||
|
||
<p>A connection string is basically a string consisted of key-value pair separated by ";". Basic format is {{ <}key{>}={ <}value{>}[;{ <}key{>}={ <}value{>}]} where supported key name are as follow: <ul><li><p>Endpoint - URL that points to the servicebus namespace </p></li><li><p>EntityPath - Path to the service bus entity (queue/topic/subscription/). For queues and topics, it is just the entity name. For subscriptions, path is <topicName>/subscriptions/<subscriptionName> </p></li><li><p>SharedAccessKeyName - Key name to the corresponding shared access policy rule for the namespace, or entity. </p></li><li><p>SharedAccessKey - Key value for the corresponding shared access policy rule of the namespace or entity. </p></li><li><p>SharedAccessSignatureToken - Instead of a key name and key value, clients can provide an already generated SAS Token. </p></li><li><p>OperationTimeout - Default timeout to be used for all senders, receiver and clients created from this connection string. </p></li><li><p>RetryPolicy - Name of the retry policy. </p></li></ul></p>
|
||
syntax:
|
||
content: public class ConnectionStringBuilder
|
||
- uid: com.microsoft.azure.servicebus.primitives._service_bus_exception
|
||
parent: com.microsoft.azure.servicebus.primitives
|
||
href: com.microsoft.azure.servicebus.primitives._service_bus_exception.yml
|
||
name: ServiceBusException
|
||
nameWithType: ServiceBusException
|
||
fullName: com.microsoft.azure.servicebus.primitives.ServiceBusException
|
||
type: Class
|
||
summary: <p>This is the base exception that service bus will generate for all error cases. </p>
|
||
syntax:
|
||
content: public class ServiceBusException
|
||
- uid: com.microsoft.azure.servicebus._client_settings
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._client_settings.yml
|
||
name: ClientSettings
|
||
nameWithType: ClientSettings
|
||
fullName: com.microsoft.azure.servicebus.ClientSettings
|
||
type: Class
|
||
summary: <p>Class encapsulating common client level settings like TokenProvider, RetryPolicy, OperationTimeout. </p>
|
||
syntax:
|
||
content: public class ClientSettings
|
||
- uid: com.microsoft.azure.servicebus._i_queue_client.getReceiveMode()
|
||
parent: com.microsoft.azure.servicebus._i_queue_client
|
||
href: com.microsoft.azure.servicebus._i_queue_client.yml
|
||
name: getReceiveMode()
|
||
nameWithType: IQueueClient.getReceiveMode()
|
||
fullName: com.microsoft.azure.servicebus.IQueueClient.getReceiveMode()
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets the <xref uid="com.microsoft.azure.servicebus._receive_mode" data-throw-if-not-resolved="false">ReceiveMode</xref> of the current receiver</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public ReceiveMode getReceiveMode()
|
||
return:
|
||
type: com.microsoft.azure.servicebus._receive_mode
|
||
description: <p>The receive mode. </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.send(IMessage)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: send(IMessage message)
|
||
nameWithType: IMessageSender.send(IMessage message)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.send(IMessage message)
|
||
type: Method
|
||
summary: >-
|
||
<p>Sends a message to the Azure Service Bus entity this sender is connected to. This method blocks until the message is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void send(IMessage message)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._i_message.yml
|
||
name: IMessage
|
||
nameWithType: IMessage
|
||
fullName: com.microsoft.azure.servicebus.IMessage
|
||
type: Interface
|
||
summary: >-
|
||
<p>Represents the message that is exchanged between Azure Service Bus and its clients.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public interface IMessage
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.sendBatch(Collection<? extends IMessage>)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: sendBatch(Collection<? extends IMessage> messages)
|
||
nameWithType: IMessageSender.sendBatch(Collection<? extends IMessage> messages)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.sendBatch(Collection<? extends IMessage> messages)
|
||
type: Method
|
||
summary: >-
|
||
<p>Sends a batch of messages to the Azure Service Bus entity this sender is connected to. This method blocks until the batch is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void sendBatch(Collection<? extends IMessage> messages)
|
||
parameters:
|
||
- id: messages
|
||
type: d56263b8com.microsoft.azure.servicebus._i_messagea08ddfce
|
||
description: <p>collection of messages to be sent to the entity </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.sendAsync(IMessage)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: sendAsync(IMessage message)
|
||
nameWithType: IMessageSender.sendAsync(IMessage message)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.sendAsync(IMessage message)
|
||
type: Method
|
||
summary: >-
|
||
<p>Sends a message to the Azure Service Bus entity this sender is connected to. This is an asynchronous method returning a CompletableFuture which completes when the message is sent to the entity.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Void> sendAsync(IMessage message)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
return:
|
||
type: db03ee24
|
||
description: <p>a CompletableFuture representing the pending send </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.sendBatchAsync(Collection<? extends IMessage>)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: sendBatchAsync(Collection<? extends IMessage> messages)
|
||
nameWithType: IMessageSender.sendBatchAsync(Collection<? extends IMessage> messages)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.sendBatchAsync(Collection<? extends IMessage> messages)
|
||
type: Method
|
||
summary: >-
|
||
<p>Sends a batch of messages to the Azure Service Bus entity this sender is connected to. This is an asynchronous method returning a CompletableFuture which completes when the batch is sent to the entity.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Void> sendBatchAsync(Collection<? extends IMessage> messages)
|
||
parameters:
|
||
- id: messages
|
||
type: d56263b8com.microsoft.azure.servicebus._i_messagea08ddfce
|
||
description: <p>collection of messages to be sent to the entity </p>
|
||
return:
|
||
type: db03ee24
|
||
description: <p>a CompletableFuture representing the pending send </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.scheduleMessageAsync(IMessage,Instant)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
nameWithType: IMessageSender.scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
type: Method
|
||
summary: >-
|
||
<p>Sends a scheduled message to the Azure Service Bus entity this sender is connected to. A scheduled message is enqueued and made available to receivers only at the scheduled enqueue time. This is an asynchronous method returning a CompletableFuture which completes when the message is sent to the entity. The CompletableFuture, on completion, returns the sequence number of the scheduled message which can be used to cancel the scheduling of the message.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Long> scheduleMessageAsync(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
- id: scheduledEnqueueTimeUtc
|
||
type: 328f8254
|
||
description: <p>instant at which the message should be enqueued in the entity </p>
|
||
return:
|
||
type: 30822cb1
|
||
description: <p>a CompletableFuture representing the pending send, which returns the sequence number of the scheduled message. This sequence number can be used to cancel the scheduling of the message. </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.cancelScheduledMessageAsync(long)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: cancelScheduledMessageAsync(long sequenceNumber)
|
||
nameWithType: IMessageSender.cancelScheduledMessageAsync(long sequenceNumber)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.cancelScheduledMessageAsync(long sequenceNumber)
|
||
type: Method
|
||
summary: >-
|
||
<p>Cancels the enqueuing of an already sent scheduled message, if it was not already enqueued. This is an asynchronous method returning a CompletableFuture which completes when the message is cancelled.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public CompletableFuture<Void> cancelScheduledMessageAsync(long sequenceNumber)
|
||
parameters:
|
||
- id: sequenceNumber
|
||
type: 0364520f
|
||
description: <p>sequence number of the scheduled message </p>
|
||
return:
|
||
type: db03ee24
|
||
description: <p>a CompletableFuture representing the pending cancellation </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.scheduleMessage(IMessage,Instant)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
nameWithType: IMessageSender.scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
type: Method
|
||
summary: >-
|
||
<p>Sends a scheduled message to the Azure Service Bus entity this sender is connected to. A scheduled message is enqueued and made available to receivers only at the scheduled enqueue time. This method blocks until the message is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public long scheduleMessage(IMessage message, Instant scheduledEnqueueTimeUtc)
|
||
parameters:
|
||
- id: message
|
||
type: com.microsoft.azure.servicebus._i_message
|
||
description: <p>message to be sent to the entity </p>
|
||
- id: scheduledEnqueueTimeUtc
|
||
type: 328f8254
|
||
description: <p>instant at which the message should be enqueued in the entity </p>
|
||
return:
|
||
type: 0364520f
|
||
description: <p>sequence number of the scheduled message </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_sender.cancelScheduledMessage(long)
|
||
parent: com.microsoft.azure.servicebus._i_message_sender
|
||
href: com.microsoft.azure.servicebus._i_message_sender.yml
|
||
name: cancelScheduledMessage(long sequenceNumber)
|
||
nameWithType: IMessageSender.cancelScheduledMessage(long sequenceNumber)
|
||
fullName: com.microsoft.azure.servicebus.IMessageSender.cancelScheduledMessage(long sequenceNumber)
|
||
type: Method
|
||
summary: >-
|
||
<p>Cancels the enqueuing of an already sent scheduled message, if it was not already enqueued. This method blocks until the message is sent to the entity. Calling this method is equivalent to calling . For better performance, use async methods.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void cancelScheduledMessage(long sequenceNumber)
|
||
parameters:
|
||
- id: sequenceNumber
|
||
type: 0364520f
|
||
description: <p>sequence number of the scheduled message </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_entity_client.getEntityPath()
|
||
parent: com.microsoft.azure.servicebus._i_message_entity_client
|
||
href: com.microsoft.azure.servicebus._i_message_entity_client.yml
|
||
name: getEntityPath()
|
||
nameWithType: IMessageEntityClient.getEntityPath()
|
||
fullName: com.microsoft.azure.servicebus.IMessageEntityClient.getEntityPath()
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets the path of the entity this client is sending messages to or receiving messages from.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String getEntityPath()
|
||
return:
|
||
type: "26831127"
|
||
description: <p>path of the entity this client is connecting to </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_handler
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._i_message_handler.yml
|
||
name: IMessageHandler
|
||
nameWithType: IMessageHandler
|
||
fullName: com.microsoft.azure.servicebus.IMessageHandler
|
||
type: Interface
|
||
summary: <p>Defines the contract for registering the callback <xref uid="" data-throw-if-not-resolved="false">QueueClient#registerMessageHandler(IMessageHandler)</xref> and <xref uid="" data-throw-if-not-resolved="false">SubscriptionClient#registerMessageHandler(IMessageHandler)</xref> for <xref uid="com.microsoft.azure.servicebus._queue_client" data-throw-if-not-resolved="false">QueueClient</xref> and <xref uid="com.microsoft.azure.servicebus._subscription_client" data-throw-if-not-resolved="false">SubscriptionClient</xref>. </p>
|
||
syntax:
|
||
content: public interface IMessageHandler
|
||
- uid: com.microsoft.azure.servicebus._message_handler_options
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._message_handler_options.yml
|
||
name: MessageHandlerOptions
|
||
nameWithType: MessageHandlerOptions
|
||
fullName: com.microsoft.azure.servicebus.MessageHandlerOptions
|
||
type: Class
|
||
summary: <p>The OnMessage handler processing options. </p>
|
||
syntax:
|
||
content: public class MessageHandlerOptions
|
||
- uid: com.microsoft.azure.servicebus._i_session_handler
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._i_session_handler.yml
|
||
name: ISessionHandler
|
||
nameWithType: ISessionHandler
|
||
fullName: com.microsoft.azure.servicebus.ISessionHandler
|
||
type: Interface
|
||
summary: <p>Defines the contract for registering the session message processing callback <xref uid="" data-throw-if-not-resolved="false">QueueClient#registerSessionHandler(ISessionHandler)</xref> or <xref uid="" data-throw-if-not-resolved="false">SubscriptionClient#registerSessionHandler(ISessionHandler)</xref> for <xref uid="com.microsoft.azure.servicebus._queue_client" data-throw-if-not-resolved="false">QueueClient</xref> and <xref uid="com.microsoft.azure.servicebus._subscription_client" data-throw-if-not-resolved="false">SubscriptionClient</xref>. </p>
|
||
syntax:
|
||
content: public interface ISessionHandler
|
||
- uid: com.microsoft.azure.servicebus._session_handler_options
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._session_handler_options.yml
|
||
name: SessionHandlerOptions
|
||
nameWithType: SessionHandlerOptions
|
||
fullName: com.microsoft.azure.servicebus.SessionHandlerOptions
|
||
type: Class
|
||
summary: <p>The OnSession handler processing options. </p>
|
||
syntax:
|
||
content: public class SessionHandlerOptions
|
||
- uid: com.microsoft.azure.servicebus._i_queue_client.getQueueName()
|
||
parent: com.microsoft.azure.servicebus._i_queue_client
|
||
href: com.microsoft.azure.servicebus._i_queue_client.yml
|
||
name: getQueueName()
|
||
nameWithType: IQueueClient.getQueueName()
|
||
fullName: com.microsoft.azure.servicebus.IQueueClient.getQueueName()
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets the name of the queue.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String getQueueName()
|
||
return:
|
||
type: "26831127"
|
||
description: <p>The name of the queue. </p>
|
||
- uid: com.microsoft.azure.servicebus._i_message_session
|
||
parent: com.microsoft.azure.servicebus
|
||
href: com.microsoft.azure.servicebus._i_message_session.yml
|
||
name: IMessageSession
|
||
nameWithType: IMessageSession
|
||
fullName: com.microsoft.azure.servicebus.IMessageSession
|
||
type: Interface
|
||
summary: >-
|
||
<p>Describes a Session object. IMessageSession can be used to perform operations on sessions. </p>
|
||
|
||
<p>Service Bus Sessions, also called 'Groups' in the AMQP 1.0 protocol, are unbounded sequences of related messages. ServiceBus guarantees ordering of messages in a session. </p>
|
||
|
||
<p>Any sender can create a session when submitting messages into a Topic or Queue by setting the <xref uid="" data-throw-if-not-resolved="false">Message#sessionId</xref> property on Message to some application defined unique identifier. At the AMQP 1.0 protocol level, this value maps to the group-id property. </p>
|
||
|
||
<p>Sessions come into existence when there is at least one message with the session's SessionId in the Queue or Topic subscription. Once a Session exists, there is no defined moment or gesture for when the session expires or disappears. </p>
|
||
syntax:
|
||
content: public interface IMessageSession extends IMessageReceiver
|