Share via

Queue Interface

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

Implements

IndependentChildResource<ServiceBusManager,SBQueueInner> Refreshable<Queue> Updatable<Update>

public interface Queue
extends IndependentChildResource<ServiceBusManager,SBQueueInner>, Refreshable<Queue>, Updatable<Update>

Type representing Service Bus queue.

Method Summary

Modifier and Type Method and Description
abstract OffsetDateTime accessedAt()
abstract long activeMessageCount()
abstract QueueAuthorizationRules authorizationRules()
abstract OffsetDateTime createdAt()
abstract long currentSizeInBytes()
abstract long deadLetterMessageCount()
abstract Duration defaultMessageTtlDuration()
abstract long deleteOnIdleDurationInMinutes()
abstract Duration duplicateMessageDetectionHistoryDuration()
abstract boolean isBatchedOperationsEnabled()
abstract boolean isDeadLetteringEnabledForExpiredMessages()
abstract boolean isDuplicateDetectionEnabled()
abstract boolean isExpressEnabled()
abstract boolean isPartitioningEnabled()
abstract boolean isSessionEnabled()
abstract long lockDurationInSeconds()
abstract int maxDeliveryCountBeforeDeadLetteringMessage()
abstract long maxSizeInMB()
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 a message was sent, or the last time there was a receive request to this queue

activeMessageCount

public abstract long activeMessageCount()

Returns:

number of active messages in the queue

authorizationRules

public abstract QueueAuthorizationRules authorizationRules()

Returns:

entry point to manage authorization rules for the Service Bus queue

createdAt

public abstract OffsetDateTime createdAt()

Returns:

the exact time the queue was created

currentSizeInBytes

public abstract long currentSizeInBytes()

Returns:

current size of the queue, in bytes

deadLetterMessageCount

public abstract long deadLetterMessageCount()

Returns:

number of messages in the dead-letter queue

defaultMessageTtlDuration

public abstract Duration defaultMessageTtlDuration()

Returns:

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

deleteOnIdleDurationInMinutes

public abstract long deleteOnIdleDurationInMinutes()

Returns:

the idle duration after which the queue is automatically deleted

duplicateMessageDetectionHistoryDuration

public abstract Duration duplicateMessageDetectionHistoryDuration()

Returns:

the duration of the duplicate detection history

isBatchedOperationsEnabled

public abstract boolean isBatchedOperationsEnabled()

Returns:

indicates whether server-side batched operations are enabled

isDeadLetteringEnabledForExpiredMessages

public abstract boolean isDeadLetteringEnabledForExpiredMessages()

Returns:

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

isDuplicateDetectionEnabled

public abstract boolean isDuplicateDetectionEnabled()

Returns:

indicates if this queue requires duplicate detection

isExpressEnabled

public abstract boolean isExpressEnabled()

Returns:

indicates whether express entities are enabled

isPartitioningEnabled

public abstract boolean isPartitioningEnabled()

Returns:

indicates whether the queue is to be partitioned across multiple message brokers

isSessionEnabled

public abstract boolean isSessionEnabled()

Returns:

indicates whether the queue 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

maxSizeInMB

public abstract long maxSizeInMB()

Returns:

the maximum size of memory allocated for the queue in megabytes

messageCount

public abstract long messageCount()

Returns:

the number of messages in the queue

scheduledMessageCount

public abstract long scheduledMessageCount()

Returns:

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

status

public abstract EntityStatus status()

Returns:

the current status of the queue

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 queue was updated

Applies to