Package com.azure.messaging.servicebus.models

Class DeferOptions

java.lang.Object

com.azure.messaging.servicebus.models.DeferOptions

public final class DeferOptions
extends Object

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

See Also:

• ServiceBusReceiverAsyncClient.defer(ServiceBusReceivedMessage, DeferOptions)
• ServiceBusReceiverClient.defer(ServiceBusReceivedMessage, DeferOptions)
• Settling messages

Constructor Summary

Constructors

Constructor	Description
DeferOptions()	Creates a new instance of options to specify when deferring messages.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getPropertiesToModify()	Gets the message properties to modify while deferring the message.
ServiceBusTransactionContext	getTransactionContext()	Gets the transaction associated with the settlement operation.
DeferOptions	setPropertiesToModify(Map<String,Object> propertiesToModify)	Sets the message properties to modify while deferring the message.
DeferOptions	setTransactionContext(ServiceBusTransactionContext transactionContext)	Sets the ServiceBusTransactionContext to the options.

Methods inherited from class java.lang.Object

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

Constructor Details

DeferOptions

public DeferOptions()

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

Method Details

setPropertiesToModify

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

Sets the message properties to modify while deferring the message.

Parameters:

propertiesToModify - Message properties to modify.

Returns:

The updated DeferOptions object.

getPropertiesToModify

public Map<String,Object> getPropertiesToModify()

Gets the message properties to modify while deferring the message.

Returns:

The message properties to modify while deferring the message.

setTransactionContext

public DeferOptions setTransactionContext(ServiceBusTransactionContext transactionContext)

Sets the ServiceBusTransactionContext to the options.

Parameters:

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

Returns:

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