com.azure.messaging.servicebus.models

Class ReceiveAsyncOptions

java.lang.Object

com.azure.messaging.servicebus.models.ReceiveAsyncOptions

public class ReceiveAsyncOptions
extends Object

Options set when receiving using ServiceBusReceiverAsyncClient.

Constructor Summary

Constructors

Constructor and Description
ReceiveAsyncOptions()

Method Summary

Modifier and Type	Method and Description
Duration	getMaxAutoLockRenewalDuration() Gets the amount of time to continue auto-renewing the message lock.
boolean	isAutoCompleteEnabled() Gets whether the message should be automatically completed when consumers are finished processing the message.
ReceiveAsyncOptions	setIsAutoCompleteEnabled(boolean isAutoCompleteEnabled) Sets whether the message should be automatically completed when consumers are finished processing the message.
ReceiveAsyncOptions	setMaxAutoLockRenewalDuration(Duration maxAutoLockRenewalDuration) Sets the amount of time to continue auto-renewing the message lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiveAsyncOptions

public ReceiveAsyncOptions()

Method Detail

isAutoCompleteEnabled

public boolean isAutoCompleteEnabled()

Gets whether the message should be automatically completed when consumers are finished processing the message.

Returns:

true to automatically complete the message; false otherwise.

setIsAutoCompleteEnabled

public ReceiveAsyncOptions setIsAutoCompleteEnabled(boolean isAutoCompleteEnabled)

Sets whether the message should be automatically completed when consumers are finished processing the message.

Parameters:

isAutoCompleteEnabled - true to automatically complete the message; false otherwise.

Returns:

The updated ReceiveAsyncOptions object.

getMaxAutoLockRenewalDuration

public Duration getMaxAutoLockRenewalDuration()

Gets the amount of time to continue auto-renewing the message lock.

Returns:

the amount of time to continue auto-renewing the message lock. Duration.ZERO or null indicates that auto-renewal is disabled.

setMaxAutoLockRenewalDuration

public ReceiveAsyncOptions setMaxAutoLockRenewalDuration(Duration maxAutoLockRenewalDuration)

Sets the amount of time to continue auto-renewing the message lock. Setting Duration.ZERO or null disables auto-renewal.

Parameters:

maxAutoLockRenewalDuration - the amount of time to continue auto-renewing the message lock. Duration.ZERO or null indicates that auto-renewal is disabled.

Returns:

The updated ReceiveAsyncOptions object.