Package com.azure.resourcemanager.servicebus.models

Interface ServiceBusSubscription

All Superinterfaces:
GroupableResource<ServiceBusManager,SBSubscriptionInner>, HasId, HasInnerModel<SBSubscriptionInner>, HasManager<ServiceBusManager>, HasName, HasResourceGroup, IndependentChild<ServiceBusManager>, IndependentChildResource<ServiceBusManager,SBSubscriptionInner>, Indexable, Refreshable<ServiceBusSubscription>, Resource, Updatable<ServiceBusSubscription.Update>
public interface ServiceBusSubscription extends IndependentChildResource<ServiceBusManager,SBSubscriptionInner>, Refreshable<ServiceBusSubscription>, Updatable<ServiceBusSubscription.Update>
Type representing service bus topic subscription.

  • Method Details

    • createdAt

      OffsetDateTime createdAt()
      Gets the exact time the message was created.
      Returns:
      the exact time the message was created

    • accessedAt

      OffsetDateTime accessedAt()
      Gets last time there was a receive request to this subscription.
      Returns:
      last time there was a receive request to this subscription

    • updatedAt

      OffsetDateTime updatedAt()
      Gets the exact time the message was updated.
      Returns:
      the exact time the message was updated

    • isBatchedOperationsEnabled

      boolean isBatchedOperationsEnabled()
      Checks whether server-side batched operations are enabled.
      Returns:
      indicates whether server-side batched operations are enabled

    • isDeadLetteringEnabledForExpiredMessages

      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

    • isSessionEnabled

      boolean isSessionEnabled()
      Checks whether the subscription supports sessions.
      Returns:
      indicates whether the subscription supports sessions

    • lockDurationInSeconds

      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

    • deleteOnIdleDurationInMinutes

      long deleteOnIdleDurationInMinutes()
      Gets the idle duration after which the subscription is automatically deleted.
      Returns:
      the idle duration after which the subscription is automatically deleted.

    • defaultMessageTtlDuration

      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.

    • maxDeliveryCountBeforeDeadLetteringMessage

      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

      long messageCount()
      Gets the number of messages in the subscription.
      Returns:
      the number of messages in the subscription

    • activeMessageCount

      long activeMessageCount()
      Gets number of active messages in the subscription.
      Returns:
      number of active messages in the subscription

    • deadLetterMessageCount

      long deadLetterMessageCount()
      Gets number of messages in the dead-letter subscription.
      Returns:
      number of messages in the dead-letter subscription

    • scheduledMessageCount

      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

    • transferDeadLetterMessageCount

      long transferDeadLetterMessageCount()
      Gets number of messages transferred into dead letters.
      Returns:
      number of messages transferred into dead letters

    • transferMessageCount

      long transferMessageCount()
      Gets number of messages transferred to another queue, topic, or subscription.
      Returns:
      number of messages transferred to another queue, topic, or subscription

    • status

      EntityStatus status()
      Gets the current status of the subscription.
      Returns:
      the current status of the subscription

    • isDeadLetteringEnabledForFilterEvaluationFailedMessages

      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