public final class DeadLetterOptions extends Object
Constructor and Description |
---|
DeadLetterOptions() |
Modifier and Type | Method and Description |
---|---|
String |
getDeadLetterErrorDescription()
Gets the error description for putting put message in dead letter sub-queue.
|
String |
getDeadLetterReason()
Gets the reason for putting put message in dead letter sub-queue.
|
Map<String,Object> |
getPropertiesToModify()
Gets the message properties to modify while putting put message in dead letter sub-queue.
|
ServiceBusTransactionContext |
getTransactionContext()
Gets the transaction associated with the settlement operation.
|
DeadLetterOptions |
setDeadLetterErrorDescription(String deadLetterErrorDescription)
Sets the error description while putting message in dead letter sub-queue.
|
DeadLetterOptions |
setDeadLetterReason(String deadLetterReason)
Sets the reason while putting message in dead letter sub-queue.
|
DeadLetterOptions |
setPropertiesToModify(Map<String,Object> propertiesToModify)
Sets the message properties to modify while putting message in dead letter sub-queue.
|
DeadLetterOptions |
setTransactionContext(ServiceBusTransactionContext transactionContext)
Sets the
ServiceBusTransactionContext to the options. |
public DeadLetterOptions setDeadLetterReason(String deadLetterReason)
deadLetterReason
- while putting message in dead letter sub-queue.DeadLetterOptions
object.public DeadLetterOptions setDeadLetterErrorDescription(String deadLetterErrorDescription)
deadLetterErrorDescription
- while putting message in dead letter sub-queue.DeadLetterOptions
object.public DeadLetterOptions setPropertiesToModify(Map<String,Object> propertiesToModify)
propertiesToModify
- Message properties to modify.DeadLetterOptions
object.public String getDeadLetterReason()
public String getDeadLetterErrorDescription()
public Map<String,Object> getPropertiesToModify()
public DeadLetterOptions setTransactionContext(ServiceBusTransactionContext transactionContext)
ServiceBusTransactionContext
to the options.transactionContext
- The ServiceBusTransactionContext
that will be used to dead letter a message.DeadLetterOptions
object.ServiceBusSenderClient.createTransaction()
,
ServiceBusSenderAsyncClient.createTransaction()
,
ServiceBusReceiverClient.createTransaction()
,
ServiceBusReceiverAsyncClient.createTransaction()
public ServiceBusTransactionContext getTransactionContext()
null
if there is none.Copyright © 2021 Microsoft Corporation. All rights reserved.