Package com.azure.resourcemanager.servicebus.models

Interface Queue

All Superinterfaces:
GroupableResource<ServiceBusManager,SBQueueInner>, HasId, HasInnerModel<SBQueueInner>, HasManager<ServiceBusManager>, HasName, HasResourceGroup, IndependentChild<ServiceBusManager>, IndependentChildResource<ServiceBusManager,SBQueueInner>, Indexable, Refreshable<Queue>, Resource, Updatable<Queue.Update>
public interface Queue extends IndependentChildResource<ServiceBusManager,SBQueueInner>, Refreshable<Queue>, Updatable<Queue.Update>
Type representing Service Bus queue.

  • Method Details

    • createdAt

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

    • accessedAt

      OffsetDateTime accessedAt()
      Gets last time a message was sent, or the last time there was a receive request to this queue.
      Returns:
      last time a message was sent, or the last time there was a receive request to this queue

    • updatedAt

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

    • maxSizeInMB

      long maxSizeInMB()
      Gets the maximum size of memory allocated for the queue in megabytes.
      Returns:
      the maximum size of memory allocated for the queue in megabytes

    • currentSizeInBytes

      long currentSizeInBytes()
      Gets current size of the queue.
      Returns:
      current size of the queue, in bytes

    • 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 queue has dead letter support when a message expires.
      Returns:
      indicates whether this queue has dead letter support when a message expires

    • isExpressEnabled

      boolean isExpressEnabled()
      Checks whether express entities are enabled.
      Returns:
      indicates whether express entities are enabled

    • isPartitioningEnabled

      boolean isPartitioningEnabled()
      Checks whether the queue is to be partitioned across multiple message brokers.
      Returns:
      indicates whether the queue is to be partitioned across multiple message brokers

    • isSessionEnabled

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

    • isDuplicateDetectionEnabled

      boolean isDuplicateDetectionEnabled()
      Checks whether this queue requires duplicate detection.
      Returns:
      indicates if this queue requires duplicate detection

    • 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 queue is automatically deleted.
      Returns:
      the idle duration after which the queue 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 queue

    • duplicateMessageDetectionHistoryDuration

      Duration duplicateMessageDetectionHistoryDuration()
      GEts the duration of the duplicate detection history.
      Returns:
      the duration of the duplicate detection history

    • 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 queue.
      Returns:
      the number of messages in the queue

    • activeMessageCount

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

    • deadLetterMessageCount

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

    • scheduledMessageCount

      long scheduledMessageCount()
      Gets number of messages sent to the queue that are yet to be released for consumption
      Returns:
      number of messages sent to the queue 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 queue.
      Returns:
      the current status of the queue

    • authorizationRules

      QueueAuthorizationRules authorizationRules()
      Gets entry point to manage authorization rules for the Service Bus queue.
      Returns:
      entry point to manage authorization rules for the Service Bus queue