com.azure.resourcemanager.servicebus.models

Interface Queue

All Superinterfaces:

GroupableResource<ManagerT,InnerT>, HasId, HasInnerModel<InnerT>, HasManager<ManagerT>, HasName, HasResourceGroup, IndependentChild<ManagerT>, 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.

Nested Class Summary

Nested Classes

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

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

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Field Summary

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

DUMMY

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	accessedAt()
long	activeMessageCount()
QueueAuthorizationRules	authorizationRules()
OffsetDateTime	createdAt()
long	currentSizeInBytes()
long	deadLetterMessageCount()
Duration	defaultMessageTtlDuration()
long	deleteOnIdleDurationInMinutes()
Duration	duplicateMessageDetectionHistoryDuration()
boolean	isBatchedOperationsEnabled()
boolean	isDeadLetteringEnabledForExpiredMessages()
boolean	isDuplicateDetectionEnabled()
boolean	isExpressEnabled()
boolean	isPartitioningEnabled()
boolean	isSessionEnabled()
long	lockDurationInSeconds()
int	maxDeliveryCountBeforeDeadLetteringMessage()
long	maxSizeInMB()
long	messageCount()
long	scheduledMessageCount()
EntityStatus	status()
long	transferDeadLetterMessageCount()
long	transferMessageCount()
OffsetDateTime	updatedAt()

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.Indexable

key

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

id

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

name

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

innerModel

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

resourceGroupName

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

manager

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

refresh, refreshAsync

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

update

Method Detail

createdAt

OffsetDateTime createdAt()

Returns:

the exact time the queue was created

accessedAt

OffsetDateTime accessedAt()

Returns:

last time a message was sent, or the last time there was a receive request to this queue

updatedAt

OffsetDateTime updatedAt()

Returns:

the exact time the queue was updated

maxSizeInMB

long maxSizeInMB()

Returns:

the maximum size of memory allocated for the queue in megabytes

currentSizeInBytes

long currentSizeInBytes()

Returns:

current size of the queue, in bytes

isBatchedOperationsEnabled

boolean isBatchedOperationsEnabled()

Returns:

indicates whether server-side batched operations are enabled

isDeadLetteringEnabledForExpiredMessages

boolean isDeadLetteringEnabledForExpiredMessages()

Returns:

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

isExpressEnabled

boolean isExpressEnabled()

Returns:

indicates whether express entities are enabled

isPartitioningEnabled

boolean isPartitioningEnabled()

Returns:

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

isSessionEnabled

boolean isSessionEnabled()

Returns:

indicates whether the queue supports sessions

isDuplicateDetectionEnabled

boolean isDuplicateDetectionEnabled()

Returns:

indicates if this queue requires duplicate detection

lockDurationInSeconds

long lockDurationInSeconds()

Returns:

the duration of peek-lock which is the amount of time that the message is locked for other receivers

deleteOnIdleDurationInMinutes

long deleteOnIdleDurationInMinutes()

Returns:

the idle duration after which the queue is automatically deleted

defaultMessageTtlDuration

Duration defaultMessageTtlDuration()

Returns:

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

duplicateMessageDetectionHistoryDuration

Duration duplicateMessageDetectionHistoryDuration()

Returns:

the duration of the duplicate detection history

maxDeliveryCountBeforeDeadLetteringMessage

int maxDeliveryCountBeforeDeadLetteringMessage()

Returns:

the maximum number of a message delivery before marking it as dead-lettered

messageCount

long messageCount()

Returns:

the number of messages in the queue

activeMessageCount

long activeMessageCount()

Returns:

number of active messages in the queue

deadLetterMessageCount

long deadLetterMessageCount()

Returns:

number of messages in the dead-letter queue

scheduledMessageCount

long scheduledMessageCount()

Returns:

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

transferDeadLetterMessageCount

long transferDeadLetterMessageCount()

Returns:

number of messages transferred into dead letters

transferMessageCount

long transferMessageCount()

Returns:

number of messages transferred to another queue, topic, or subscription

status

EntityStatus status()

Returns:

the current status of the queue

authorizationRules

QueueAuthorizationRules authorizationRules()

Returns:

entry point to manage authorization rules for the Service Bus queue