Share via

ServiceBusSubscription Interface

  • Reference
Package:
com.azure.resourcemanager.servicebus.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-servicebus:2.44.0

Implements

IndependentChildResource<ServiceBusManager,SBSubscriptionInner> Refreshable<ServiceBusSubscription> Updatable<Update>

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

Type representing service bus topic subscription.

Method Summary

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

Method Details

accessedAt

public abstract OffsetDateTime accessedAt()

Returns:

last time there was a receive request to this subscription

activeMessageCount

public abstract long activeMessageCount()

Returns:

number of active messages in the subscription

createdAt

public abstract OffsetDateTime createdAt()

Returns:

the exact time the message was created

deadLetterMessageCount

public abstract long deadLetterMessageCount()

Returns:

number of messages in the dead-letter subscription

defaultMessageTtlDuration

public abstract Duration defaultMessageTtlDuration()

Returns:

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

deleteOnIdleDurationInMinutes

public abstract long deleteOnIdleDurationInMinutes()

Returns:

the idle duration after which the subscription is automatically deleted.

isBatchedOperationsEnabled

public abstract boolean isBatchedOperationsEnabled()

Returns:

indicates whether server-side batched operations are enabled

isDeadLetteringEnabledForExpiredMessages

public abstract boolean isDeadLetteringEnabledForExpiredMessages()

Returns:

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

isDeadLetteringEnabledForFilterEvaluationFailedMessages

public abstract boolean isDeadLetteringEnabledForFilterEvaluationFailedMessages()

Returns:

indicates whether subscription has dead letter support on filter evaluation exceptions

isSessionEnabled

public abstract boolean isSessionEnabled()

Returns:

indicates whether the subscription supports sessions

lockDurationInSeconds

public abstract long lockDurationInSeconds()

Returns:

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

maxDeliveryCountBeforeDeadLetteringMessage

public abstract int maxDeliveryCountBeforeDeadLetteringMessage()

Returns:

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

messageCount

public abstract long messageCount()

Returns:

the number of messages in the subscription

scheduledMessageCount

public abstract long scheduledMessageCount()

Returns:

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

status

public abstract EntityStatus status()

Returns:

the current status of the subscription

transferDeadLetterMessageCount

public abstract long transferDeadLetterMessageCount()

Returns:

number of messages transferred into dead letters

transferMessageCount

public abstract long transferMessageCount()

Returns:

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

updatedAt

public abstract OffsetDateTime updatedAt()

Returns:

the exact time the message was updated

Applies to