Package com.azure.messaging.servicebus.models

Class CompleteOptions

java.lang.Object

com.azure.messaging.servicebus.models.CompleteOptions

public final class CompleteOptions
extends Object

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

See Also:

• ServiceBusReceiverAsyncClient.complete(ServiceBusReceivedMessage, CompleteOptions)
• ServiceBusReceiverClient.complete(ServiceBusReceivedMessage, CompleteOptions)
• Settling messages

Constructor Summary

Constructors

Constructor	Description
CompleteOptions()	Creates a new instance of options to specify when completing messages.

Method Summary

Modifier and Type	Method	Description
ServiceBusTransactionContext	getTransactionContext()	Gets the transaction associated with the settlement operation.
CompleteOptions	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

CompleteOptions

public CompleteOptions()

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

Method Details

setTransactionContext

public CompleteOptions setTransactionContext(ServiceBusTransactionContext transactionContext)

Sets the ServiceBusTransactionContext to the options.

Parameters:

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

Returns:

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