### YamlMime:JavaType
uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump"
name: "IMessageAndSessionPump"
nameWithType: "IMessageAndSessionPump"
summary: "Represents the pump which is underneath the clients that handles message processing."
syntax: "public interface **IMessageAndSessionPump**"
methods:
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(java.util.UUID)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(UUID lockToken)"
name: "abandon(UUID lockToken)"
nameWithType: "IMessageAndSessionPump.abandon(UUID lockToken)"
summary: "Abandon with lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
syntax: "public abstract void abandon(UUID lockToken)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(UUID lockToken, TransactionContext transaction)"
name: "abandon(UUID lockToken, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.abandon(UUID lockToken, TransactionContext transaction)"
summary: "Abandon with lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract void abandon(UUID lockToken, TransactionContext transaction)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(java.util.UUID,java.util.Map)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(UUID lockToken, Map propertiesToModify)"
name: "abandon(UUID lockToken, Map propertiesToModify)"
nameWithType: "IMessageAndSessionPump.abandon(UUID lockToken, Map propertiesToModify)"
summary: "Abandon with lock token and updated message property."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
syntax: "public abstract void abandon(UUID lockToken, Map propertiesToModify)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
name: "abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
summary: "Abandon with lock token and updated message property."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract void abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(java.util.UUID)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(UUID lockToken)"
name: "abandonAsync(UUID lockToken)"
nameWithType: "IMessageAndSessionPump.abandonAsync(UUID lockToken)"
summary: "Asynchronously abandon with lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken)"
desc: "Asynchronously abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message."
returns:
description: "a CompletableFuture representing the pending abandon."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(UUID lockToken, TransactionContext transaction)"
name: "abandonAsync(UUID lockToken, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.abandonAsync(UUID lockToken, TransactionContext transaction)"
summary: "Asynchronously abandon with lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken, TransactionContext transaction)"
desc: "Asynchronously abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message."
returns:
description: "a CompletableFuture representing the pending abandon."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(java.util.UUID,java.util.Map)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(UUID lockToken, Map propertiesToModify)"
name: "abandonAsync(UUID lockToken, Map propertiesToModify)"
nameWithType: "IMessageAndSessionPump.abandonAsync(UUID lockToken, Map propertiesToModify)"
summary: "Asynchronously abandon with lock token and updated message property."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken, Map propertiesToModify)"
desc: "Asynchronously abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message."
returns:
description: "a CompletableFuture representing the pending abandon."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
name: "abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
summary: "Asynchronously abandon with lock token and updated message property."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
desc: "Asynchronously abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message."
returns:
description: "a CompletableFuture representing the pending abandon."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.complete(java.util.UUID)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.complete(UUID lockToken)"
name: "complete(UUID lockToken)"
nameWithType: "IMessageAndSessionPump.complete(UUID lockToken)"
summary: "Completes a using its lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
syntax: "public abstract void complete(UUID lockToken)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Completes a using its lock token. This will delete the message from the service."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.complete(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.complete(UUID lockToken, TransactionContext transaction)"
name: "complete(UUID lockToken, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.complete(UUID lockToken, TransactionContext transaction)"
summary: "Completes a using its lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract void complete(UUID lockToken, TransactionContext transaction)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Completes a using its lock token. This will delete the message from the service."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.completeAsync(java.util.UUID)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.completeAsync(UUID lockToken)"
name: "completeAsync(UUID lockToken)"
nameWithType: "IMessageAndSessionPump.completeAsync(UUID lockToken)"
summary: "Asynchronously completes a using its lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
syntax: "public abstract CompletableFuture completeAsync(UUID lockToken)"
desc: "Asynchronously completes a using its lock token. This will delete the message from the service."
returns:
description: "a CompletableFuture representing the pending complete."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.completeAsync(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.completeAsync(UUID lockToken, TransactionContext transaction)"
name: "completeAsync(UUID lockToken, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.completeAsync(UUID lockToken, TransactionContext transaction)"
summary: "Asynchronously completes a using its lock token."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract CompletableFuture completeAsync(UUID lockToken, TransactionContext transaction)"
desc: "Asynchronously completes a using its lock token. This will delete the message from the service."
returns:
description: "a CompletableFuture representing the pending complete."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken)"
name: "deadLetter(UUID lockToken)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken)"
summary: "Moves a to the deadletter sub-queue."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
syntax: "public abstract void deadLetter(UUID lockToken)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken, TransactionContext transaction)"
name: "deadLetter(UUID lockToken, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken, TransactionContext transaction)"
summary: "Moves a to the deadletter sub-queue."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract void deadLetter(UUID lockToken, TransactionContext transaction)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
summary: "Moves a to the deadletter sub-queue with deadletter reason and error description."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue with deadletter reason and error description."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
summary: "Moves a to the deadletter sub-queue with deadletter reason and error description."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue with deadletter reason and error description."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID,java.lang.String,java.lang.String,java.util.Map)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
summary: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID,java.lang.String,java.lang.String,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
summary: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID,java.util.Map)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken, Map propertiesToModify)"
name: "deadLetter(UUID lockToken, Map propertiesToModify)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken, Map propertiesToModify)"
summary: "Moves a to the deadletter sub-queue with modified message properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
syntax: "public abstract void deadLetter(UUID lockToken, Map propertiesToModify)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue with modified message properties."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
name: "deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
summary: "Moves a to the deadletter sub-queue with modified message properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract void deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Moves a to the deadletter sub-queue with modified message properties."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken)"
name: "deadLetterAsync(UUID lockToken)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken)"
summary: "Asynchronously moves a to the deadletter sub-queue with deadletter."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken)"
desc: "Asynchronously moves a to the deadletter sub-queue with deadletter."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken, TransactionContext transaction)"
name: "deadLetterAsync(UUID lockToken, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken, TransactionContext transaction)"
summary: "Asynchronously moves a to the deadletter sub-queue with deadletter."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, TransactionContext transaction)"
desc: "Asynchronously moves a to the deadletter sub-queue with deadletter."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)"
desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)"
desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String,java.util.Map)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)"
desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "The deadletter reason."
name: "deadLetterReason"
type: "String"
- description: "The deadletter error description."
name: "deadLetterErrorDescription"
type: "String"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)"
desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID,java.util.Map)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken, Map propertiesToModify)"
name: "deadLetterAsync(UUID lockToken, Map propertiesToModify)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken, Map propertiesToModify)"
summary: "Asynchronously moves a to the deadletter sub-queue with modified properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, Map propertiesToModify)"
desc: "Asynchronously moves a to the deadletter sub-queue with modified properties."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
name: "deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
nameWithType: "IMessageAndSessionPump.deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
summary: "Asynchronously moves a to the deadletter sub-queue with modified properties."
modifiers:
- "abstract"
parameters:
- description: "Message lock token "
name: "lockToken"
type: "UUID"
- description: "Message properties to modify."
name: "propertiesToModify"
type: "Map<String,Object>"
- description: " which this operation should enlist to."
name: "transaction"
type: ""
syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)"
desc: "Asynchronously moves a to the deadletter sub-queue with modified properties."
returns:
description: "a CompletableFuture representing the pending deadletter."
type: "CompletableFuture<Void>"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.getPrefetchCount()"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.getPrefetchCount()"
name: "getPrefetchCount()"
nameWithType: "IMessageAndSessionPump.getPrefetchCount()"
summary: "Get the prefetch value set."
modifiers:
- "abstract"
syntax: "public abstract int getPrefetchCount()"
desc: "Get the prefetch value set."
returns:
description: "The set prefetch count value."
type: ""
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(com.microsoft.azure.servicebus.IMessageHandler)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler)"
name: "registerMessageHandler(IMessageHandler handler)"
nameWithType: "IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler)"
summary: "Receive messages continuously from the entity."
deprecatedTag: "Use "
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
syntax: "@Deprecatedpublic abstract void registerMessageHandler(IMessageHandler handler)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on java.util.concurrent.commonPool()"
hasDeprecatedTag: true
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(com.microsoft.azure.servicebus.IMessageHandler,com.microsoft.azure.servicebus.MessageHandlerOptions)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)"
name: "registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)"
nameWithType: "IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)"
summary: "Receive messages continuously from the entity."
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
- description: ""
name: "handlerOptions"
type: ""
syntax: "@Deprecatedpublic abstract void registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on java.util.concurrent.commonPool()"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(com.microsoft.azure.servicebus.IMessageHandler,com.microsoft.azure.servicebus.MessageHandlerOptions,java.util.concurrent.ExecutorService)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions, ExecutorService executorService)"
name: "registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions, ExecutorService executorService)"
nameWithType: "IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions, ExecutorService executorService)"
summary: "Receive messages continuously from the entity."
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
- description: ""
name: "handlerOptions"
type: ""
- description: "ExecutorService which is used to execute methods"
name: "executorService"
type: "ExecutorService"
syntax: "public abstract void registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions, ExecutorService executorService)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on the passed executor service."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(com.microsoft.azure.servicebus.IMessageHandler,java.util.concurrent.ExecutorService)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler, ExecutorService executorService)"
name: "registerMessageHandler(IMessageHandler handler, ExecutorService executorService)"
nameWithType: "IMessageAndSessionPump.registerMessageHandler(IMessageHandler handler, ExecutorService executorService)"
summary: "Receive messages continuously from the entity."
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
- description: "ExecutorService which is used to execute methods."
name: "executorService"
type: "ExecutorService"
syntax: "public abstract void registerMessageHandler(IMessageHandler handler, ExecutorService executorService)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on the passed executor service."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(com.microsoft.azure.servicebus.ISessionHandler)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler)"
name: "registerSessionHandler(ISessionHandler handler)"
nameWithType: "IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler)"
summary: "Receive session messages continuously from the queue."
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
syntax: "@Deprecatedpublic abstract void registerSessionHandler(ISessionHandler handler)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on java.util.concurrent.commonPool()"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(com.microsoft.azure.servicebus.ISessionHandler,com.microsoft.azure.servicebus.SessionHandlerOptions)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)"
name: "registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)"
nameWithType: "IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)"
summary: "Receive session messages continuously from the queue."
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
- description: ""
name: "handlerOptions"
type: ""
syntax: "@Deprecatedpublic abstract void registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on java.util.concurrent.commonPool()"
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(com.microsoft.azure.servicebus.ISessionHandler,com.microsoft.azure.servicebus.SessionHandlerOptions,java.util.concurrent.ExecutorService)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions, ExecutorService executorService)"
name: "registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions, ExecutorService executorService)"
nameWithType: "IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions, ExecutorService executorService)"
summary: "Receive session messages continuously from the queue."
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
- description: ""
name: "handlerOptions"
type: ""
- description: "ExecutorService which is used to execute methods"
name: "executorService"
type: "ExecutorService"
syntax: "public abstract void registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions, ExecutorService executorService)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on the passed executor service."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(com.microsoft.azure.servicebus.ISessionHandler,java.util.concurrent.ExecutorService)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler, ExecutorService executorService)"
name: "registerSessionHandler(ISessionHandler handler, ExecutorService executorService)"
nameWithType: "IMessageAndSessionPump.registerSessionHandler(ISessionHandler handler, ExecutorService executorService)"
summary: "Receive session messages continuously from the queue."
modifiers:
- "abstract"
parameters:
- description: "The instance"
name: "handler"
type: ""
- description: "ExecutorService which is used to execute methods"
name: "executorService"
type: "ExecutorService"
syntax: "public abstract void registerSessionHandler(ISessionHandler handler, ExecutorService executorService)"
exceptions:
- description: "if the current thread was interrupted while waiting"
type: "InterruptedException"
- description: "if the current thread was interrupted while waiting"
type: ""
desc: "Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on the passed executor service."
- uid: "com.microsoft.azure.servicebus.IMessageAndSessionPump.setPrefetchCount(int)"
fullName: "com.microsoft.azure.servicebus.IMessageAndSessionPump.setPrefetchCount(int prefetchCount)"
name: "setPrefetchCount(int prefetchCount)"
nameWithType: "IMessageAndSessionPump.setPrefetchCount(int prefetchCount)"
summary: "Set the prefetch count of the receiver."
modifiers:
- "abstract"
parameters:
- description: "The desired prefetch count."
name: "prefetchCount"
type: ""
syntax: "public abstract void setPrefetchCount(int prefetchCount)"
exceptions:
- description: "if sets the value failed"
type: ""
desc: "Set the prefetch count of the receiver. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using Receive. Setting a non-zero value prefetches PrefetchCount number of messages. Setting the value to zero turns prefetch off. For RECEIVEANDDELETE mode, the default value is 0. For PEEKLOCK mode, the default value is 100.\n\nThe value cannot be set until the receiver is created."
type: "interface"
desc: "Represents the pump which is underneath the clients that handles message processing."
metadata: {}
package: "com.microsoft.azure.servicebus"
artifact: com.microsoft.azure:azure-servicebus:3.6.7