Queue Interface

Package:

com.azure.resourcemanager.servicebus.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-servicebus:2.47.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() Gets last time a message was sent, or the last time there was a receive request to this queue.
abstract long	activeMessageCount() Gets number of active messages in the queue.
abstract QueueAuthorizationRules	authorizationRules() Gets entry point to manage authorization rules for the Service Bus queue.
abstract OffsetDateTime	createdAt() Gets the exact time the queue was created.
abstract long	currentSizeInBytes() Gets current size of the queue.
abstract long	deadLetterMessageCount() Gets number of messages in the dead-letter queue.
abstract Duration	defaultMessageTtlDuration() Gets the duration after which the message expires.
abstract long	deleteOnIdleDurationInMinutes() Gets the idle duration after which the queue is automatically deleted.
abstract Duration	duplicateMessageDetectionHistoryDuration() GEts the duration of the duplicate detection history.
abstract boolean	isBatchedOperationsEnabled() Checks whether server-side batched operations are enabled.
abstract boolean	isDeadLetteringEnabledForExpiredMessages() Checks whether this queue has dead letter support when a message expires.
abstract boolean	isDuplicateDetectionEnabled() Checks whether this queue requires duplicate detection.
abstract boolean	isExpressEnabled() Checks whether express entities are enabled.
abstract boolean	isPartitioningEnabled() Checks whether the queue is to be partitioned across multiple message brokers.
abstract boolean	isSessionEnabled() Checks whether the queue 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	maxSizeInMB() Gets the maximum size of memory allocated for the queue in megabytes.
abstract long	messageCount() Gets the number of messages in the queue.
abstract long	scheduledMessageCount() Gets number of messages sent to the queue that are yet to be released for consumption
abstract EntityStatus	status() Gets the current status of the queue.
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 queue was updated.

Method Details

accessedAt

public abstract 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

activeMessageCount

public abstract long activeMessageCount()

Gets number of active messages in the queue.

Returns:

number of active messages in the queue

authorizationRules

public abstract 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

createdAt

public abstract OffsetDateTime createdAt()

Gets the exact time the queue was created.

Returns:

the exact time the queue was created

currentSizeInBytes

public abstract long currentSizeInBytes()

Gets current size of the queue.

Returns:

current size of the queue, in bytes

deadLetterMessageCount

public abstract long deadLetterMessageCount()

Gets number of messages in the dead-letter queue.

Returns:

number of messages in the dead-letter queue

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 queue

deleteOnIdleDurationInMinutes

public abstract long deleteOnIdleDurationInMinutes()

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

Returns:

the idle duration after which the queue is automatically deleted

duplicateMessageDetectionHistoryDuration

public abstract Duration duplicateMessageDetectionHistoryDuration()

GEts the duration of the duplicate detection history.

Returns:

the duration of the duplicate detection history

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 queue has dead letter support when a message expires.

Returns:

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

isDuplicateDetectionEnabled

public abstract boolean isDuplicateDetectionEnabled()

Checks whether this queue requires duplicate detection.

Returns:

indicates if this queue requires duplicate detection

isExpressEnabled

public abstract boolean isExpressEnabled()

Checks whether express entities are enabled.

Returns:

indicates whether express entities are enabled

isPartitioningEnabled

public abstract 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

public abstract boolean isSessionEnabled()

Checks whether the queue supports sessions.

Returns:

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

maxSizeInMB

public abstract 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

messageCount

public abstract long messageCount()

Gets the number of messages in the queue.

Returns:

the number of messages in the queue

scheduledMessageCount

public abstract 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

status

public abstract EntityStatus status()

Gets the current status of the queue.

Returns:

the current status of the queue

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

Returns:

the exact time the queue was updated