Class DeadLetterOptions

java.lang.Object

com.azure.messaging.servicebus.models.DeadLetterOptions

public final class DeadLetterOptions
extends Object

Options to specify when sending a message received via ServiceBusReceiveMode.PEEK_LOCK to the dead-letter queue .

See Also:

• ServiceBusReceiverAsyncClient.deadLetter(ServiceBusReceivedMessage, DeadLetterOptions)
• ServiceBusReceiverClient.deadLetter(ServiceBusReceivedMessage, DeadLetterOptions)
• Settling messages
• Dead-letter queues

Constructor Summary

Constructors

Constructor	Description
DeadLetterOptions()	Creates a new instance of options to specify when sending messages to the dead-letter queue (DLQ).

Method Summary

Modifier and Type	Method	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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DeadLetterOptions

public DeadLetterOptions()

Creates a new instance of options to specify when sending messages to the dead-letter queue (DLQ).

Method Details

setDeadLetterReason

public DeadLetterOptions setDeadLetterReason(String deadLetterReason)

Sets the reason while putting message in dead letter sub-queue.

Parameters:

deadLetterReason - while putting message in dead letter sub-queue.

Returns:

The updated DeadLetterOptions object.

setDeadLetterErrorDescription

public DeadLetterOptions setDeadLetterErrorDescription(String deadLetterErrorDescription)

Sets the error description while putting message in dead letter sub-queue.

Parameters:

deadLetterErrorDescription - while putting message in dead letter sub-queue.

Returns:

The updated DeadLetterOptions object.

setPropertiesToModify

public DeadLetterOptions setPropertiesToModify(Map<String,Object> propertiesToModify)

Sets the message properties to modify while putting message in dead letter sub-queue.

Parameters:

propertiesToModify - Message properties to modify.

Returns:

The updated DeadLetterOptions object.

getDeadLetterReason

public String getDeadLetterReason()

Gets the reason for putting put message in dead letter sub-queue.

Returns:

The reason for putting put message in dead letter sub-queue.

getDeadLetterErrorDescription

public String getDeadLetterErrorDescription()

Gets the error description for putting put message in dead letter sub-queue.

Returns:

The error description to for putting message in dead letter sub-queue.

getPropertiesToModify

public Map<String,Object> getPropertiesToModify()

Gets the message properties to modify while putting put message in dead letter sub-queue.

Returns:

The message properties to modify while putting message in dead letter sub-queue.

setTransactionContext

public DeadLetterOptions setTransactionContext(ServiceBusTransactionContext transactionContext)

Sets the ServiceBusTransactionContext to the options.

Parameters:

transactionContext - The ServiceBusTransactionContext that will be used to dead letter a message.

Returns:

The updated DeadLetterOptions object.

See Also:

• ServiceBusSenderClient.createTransaction()
• ServiceBusSenderAsyncClient.createTransaction()
• ServiceBusReceiverClient.createTransaction()
• ServiceBusReceiverAsyncClient.createTransaction()

getTransactionContext

public ServiceBusTransactionContext getTransactionContext()

Gets the transaction associated with the settlement operation.

Returns:

The transaction context associated with the settlement operation. null if there is none.