Class AbandonOptions

java.lang.Object

com.azure.messaging.servicebus.models.AbandonOptions

public final class AbandonOptions
extends Object

Options to specify when abandoning a message received via ServiceBusReceiveMode.PEEK_LOCK.

See Also:

• ServiceBusReceiverAsyncClient.abandon(ServiceBusReceivedMessage, AbandonOptions)
• ServiceBusReceiverClient.abandon(ServiceBusReceivedMessage, AbandonOptions)
• Settling messages

Constructor Summary

Constructors

Constructor	Description
AbandonOptions()	Creates a new instance of options to specify when abandoning messages.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getPropertiesToModify()	Gets the message properties to modify while abandoning the message.
ServiceBusTransactionContext	getTransactionContext()	Gets the transaction associated with the settlement operation.
AbandonOptions	setPropertiesToModify(Map<String,Object> propertiesToModify)	Sets the message properties to modify while abandoning message.
AbandonOptions	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

AbandonOptions

public AbandonOptions()

Creates a new instance of options to specify when abandoning messages.

Method Details

getPropertiesToModify

public Map<String,Object> getPropertiesToModify()

Gets the message properties to modify while abandoning the message.

Returns:

The message properties to modify while abandoning the message.

setPropertiesToModify

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

Sets the message properties to modify while abandoning message.

Parameters:

propertiesToModify - Message properties to modify.

Returns:

The updated AbandonOptions object.

setTransactionContext

public AbandonOptions setTransactionContext(ServiceBusTransactionContext transactionContext)

Sets the ServiceBusTransactionContext to the options.

Parameters:

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

Returns:

The updated AbandonOptions 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.