Interface ServiceBusSubscription

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ServiceBusSubscription.Definition
    The entirety of the subscription definition.
    static interface 
    ServiceBusSubscription.DefinitionStages
    Grouping of queue definition stages.
    static interface 
    ServiceBusSubscription.Update
    The template for a subscription update operation, containing all the settings that can be modified.
    static interface 
    ServiceBusSubscription.UpdateStages
    Grouping of subscription update stages.

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

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

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • 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