ServiceBusSubscription Interface

Package:

com.azure.resourcemanager.servicebus.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-servicebus:2.53.5

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() Gets last time there was a receive request to this subscription.
abstract long	activeMessageCount() Gets number of active messages in the subscription.
abstract OffsetDateTime	createdAt() Gets the exact time the message was created.
abstract long	deadLetterMessageCount() Gets number of messages in the dead-letter subscription.
abstract Duration	defaultMessageTtlDuration() Gets the duration after which the message expires.
abstract long	deleteOnIdleDurationInMinutes() Gets the idle duration after which the subscription is automatically deleted.
abstract boolean	isBatchedOperationsEnabled() Checks whether server-side batched operations are enabled.
abstract boolean	isDeadLetteringEnabledForExpiredMessages() Checks whether this subscription has dead letter support when a message expires.
abstract boolean	isDeadLetteringEnabledForFilterEvaluationFailedMessages() Checks whether subscription has dead letter support on filter evaluation exceptions.
abstract boolean	isSessionEnabled() Checks whether the subscription supports sessions.
abstract long	lockDurationInSeconds() Gets the duration of peek-lock which is the amount of time that the message is locked for other receivers.
abstract int	maxDeliveryCountBeforeDeadLetteringMessage() Gets the maximum number of a message delivery before marking it as dead-lettered.
abstract long	messageCount() Gets the number of messages in the subscription.
abstract long	scheduledMessageCount() Gets number of messages sent to the subscription that are yet to be released for consumption.
abstract EntityStatus	status() Gets the current status of the subscription.
abstract long	transferDeadLetterMessageCount() Gets number of messages transferred into dead letters.
abstract long	transferMessageCount() Gets number of messages transferred to another queue, topic, or subscription.
abstract OffsetDateTime	updatedAt() Gets the exact time the message was updated.

Method Details

accessedAt

public abstract OffsetDateTime accessedAt()

Gets last time there was a receive request to this subscription.

Returns:

last time there was a receive request to this subscription

activeMessageCount

public abstract long activeMessageCount()

Gets number of active messages in the subscription.

Returns:

number of active messages in the subscription

createdAt

public abstract OffsetDateTime createdAt()

Gets the exact time the message was created.

Returns:

the exact time the message was created

deadLetterMessageCount

public abstract long deadLetterMessageCount()

Gets number of messages in the dead-letter subscription.

Returns:

number of messages in the dead-letter subscription

defaultMessageTtlDuration

public abstract Duration defaultMessageTtlDuration()

Gets the duration after which the message expires.

Returns:

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

deleteOnIdleDurationInMinutes

public abstract long deleteOnIdleDurationInMinutes()

Gets the idle duration after which the subscription is automatically deleted.

Returns:

the idle duration after which the subscription is automatically deleted.

isBatchedOperationsEnabled

public abstract boolean isBatchedOperationsEnabled()

Checks whether server-side batched operations are enabled.

Returns:

indicates whether server-side batched operations are enabled

isDeadLetteringEnabledForExpiredMessages

public abstract boolean isDeadLetteringEnabledForExpiredMessages()

Checks whether this subscription has dead letter support when a message expires.

Returns:

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

isDeadLetteringEnabledForFilterEvaluationFailedMessages

public abstract boolean isDeadLetteringEnabledForFilterEvaluationFailedMessages()

Checks whether subscription has dead letter support on filter evaluation exceptions.

Returns:

indicates whether subscription has dead letter support on filter evaluation exceptions

isSessionEnabled

public abstract boolean isSessionEnabled()

Checks whether the subscription supports sessions.

Returns:

indicates whether the subscription supports sessions

lockDurationInSeconds

public abstract long lockDurationInSeconds()

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

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()

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

Returns:

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

messageCount

public abstract long messageCount()

Gets the number of messages in the subscription.

Returns:

the number of messages in the subscription

scheduledMessageCount

public abstract long scheduledMessageCount()

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

Returns:

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

status

public abstract EntityStatus status()

Gets the current status of the subscription.

Returns:

the current status of the subscription

transferDeadLetterMessageCount

public abstract long transferDeadLetterMessageCount()

Gets number of messages transferred into dead letters.

Returns:

number of messages transferred into dead letters

transferMessageCount

public abstract long transferMessageCount()

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

Returns:

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

updatedAt

public abstract OffsetDateTime updatedAt()

Gets the exact time the message was updated.

Returns:

the exact time the message was updated