Share via

ServiceBusSubscription Interface

  • Reference
Package:
com.microsoft.azure.management.servicebus

public interface ServiceBusSubscription extends IndependentChildResource<ServiceBusManager, SubscriptionInner>,Refreshable,Updatable<ServiceBusSubscription.Update>

Type representing service bus topic subscription.

Method Summary

Modifier and Type Method and Description
DateTime accessedAt()
long activeMessageCount()
DateTime createdAt()
long deadLetterMessageCount()
Period defaultMessageTtlDuration()
long deleteOnIdleDurationInMinutes()
boolean isBatchedOperationsEnabled()
boolean isDeadLetteringEnabledForExpiredMessages()
boolean isDeadLetteringEnabledForFilterEvaluationFailedMessages()
boolean isSessionEnabled()
long lockDurationInSeconds()
int maxDeliveryCountBeforeDeadLetteringMessage()
long messageCount()
long scheduledMessageCount()
EntityStatus status()
long transferDeadLetterMessageCount()
long transferMessageCount()
DateTime updatedAt()

Inherited Members

HasId.id() Indexable.key() HasManager<ManagerT>.manager() HasName.name() Refreshable<T>.refresh() Refreshable<T>.refreshAsync() HasResourceGroup.resourceGroupName() Updatable<T>.update()

Method Details

accessedAt

public DateTime accessedAt()

Returns:

last time there was a receive request to this subscription

activeMessageCount

public long activeMessageCount()

Returns:

number of active messages in the subscription

createdAt

public DateTime createdAt()

Returns:

the exact time the message was created

deadLetterMessageCount

public long deadLetterMessageCount()

Returns:

number of messages in the dead-letter subscription

defaultMessageTtlDuration

public Period defaultMessageTtlDuration()

Returns:

the duration after which the message expires, starting from when the message is sent to subscription.

deleteOnIdleDurationInMinutes

public long deleteOnIdleDurationInMinutes()

Returns:

the idle duration after which the subscription is automatically deleted.

isBatchedOperationsEnabled

public boolean isBatchedOperationsEnabled()

Returns:

indicates whether server-side batched operations are enabled

isDeadLetteringEnabledForExpiredMessages

public boolean isDeadLetteringEnabledForExpiredMessages()

Returns:

indicates whether this subscription has dead letter support when a message expires

isDeadLetteringEnabledForFilterEvaluationFailedMessages

public boolean isDeadLetteringEnabledForFilterEvaluationFailedMessages()

Returns:

indicates whether subscription has dead letter support on filter evaluation exceptions

isSessionEnabled

public boolean isSessionEnabled()

Returns:

indicates whether the subscription supports sessions

lockDurationInSeconds

public long lockDurationInSeconds()

Returns:

the duration of peek-lock which is the amount of time that the message is locked for other receivers

maxDeliveryCountBeforeDeadLetteringMessage

public int maxDeliveryCountBeforeDeadLetteringMessage()

Returns:

the maximum number of a message delivery before marking it as dead-lettered

messageCount

public long messageCount()

Returns:

the number of messages in the subscription

scheduledMessageCount

public long scheduledMessageCount()

Returns:

number of messages sent to the subscription that are yet to be released for consumption

status

public EntityStatus status()

Returns:

the current status of the subscription

transferDeadLetterMessageCount

public long transferDeadLetterMessageCount()

Returns:

number of messages transferred into dead letters

transferMessageCount

public long transferMessageCount()

Returns:

number of messages transferred to another queue, topic, or subscription

updatedAt

public DateTime updatedAt()

Returns:

the exact time the message was updated

Applies to