DeadLetterOptions Class

Package:

com.azure.messaging.servicebus.models

Maven Artifact:

com.azure:azure-messaging-servicebus:7.17.17

• java.lang.Object
• • com.azure.messaging.servicebus.models.SettlementOptions
  • • com.azure.messaging.servicebus.models.DeadLetterOptions

public final class DeadLetterOptions
extends com.azure.messaging.servicebus.models.SettlementOptions

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

Constructor Summary

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 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.
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 com.azure.messaging.servicebus.models.SettlementOptions

com.azure.messaging.servicebus.models.SettlementOptions.getTransactionContext com.azure.messaging.servicebus.models.SettlementOptions.setTransactionContext

Methods inherited from java.lang.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

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.

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.

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.

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.

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.

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.

setTransactionContext

public DeadLetterOptions setTransactionContext(ServiceBusTransactionContext transactionContext)

Sets the ServiceBusTransactionContext to the options.

Overrides:

DeadLetterOptions.setTransactionContext(ServiceBusTransactionContext transactionContext)

Parameters:

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

Returns:

The updated DeadLetterOptions object.