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

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

Options to specify when abandoning a ServiceBusReceivedMessage received via PEEK_LOCK.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getPropertiesToModify() Gets the message properties to modify while abandoning the message.
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 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

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.

Overrides:

AbandonOptions.setTransactionContext(ServiceBusTransactionContext transactionContext)

Parameters:

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

Returns:

The updated AbandonOptions object.