com.azure.messaging.servicebus.administration.models

Class QueueRuntimeProperties

java.lang.Object

com.azure.messaging.servicebus.administration.models.QueueRuntimeProperties

public class QueueRuntimeProperties
extends Object

Runtime properties about the queue.

See Also:

ServiceBusAdministrationAsyncClient.getQueueRuntimeProperties(String), ServiceBusAdministrationClient.getQueueRuntimeProperties(String)

Constructor Summary

Constructors

Constructor and Description
QueueRuntimeProperties(QueueProperties queueProperties) Creates a new instance with runtime properties extracted from the given QueueDescription.

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	getAccessedAt() Gets the last time a message was sent, or the last time there was a receive request to this queue.
int	getActiveMessageCount() Get the activeMessageCount property: Number of active messages in the queue, topic, or subscription.
OffsetDateTime	getCreatedAt() Gets the exact time the queue was created.
int	getDeadLetterMessageCount() Get the deadLetterMessageCount property: Number of messages that are dead lettered.
String	getName() Gets the name of the queue.
int	getScheduledMessageCount() Get the scheduledMessageCount property: Number of scheduled messages.
long	getSizeInBytes() Gets the size of the queue, in bytes.
long	getTotalMessageCount() Gets the number of messages in the queue.
int	getTransferDeadLetterMessageCount() Get the transferDeadLetterMessageCount property: Number of messages transferred into dead letters.
int	getTransferMessageCount() Get the transferMessageCount property: Number of messages transferred to another queue, topic, or subscription.
OffsetDateTime	getUpdatedAt() Gets the exact time a message was updated in the queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueueRuntimeProperties

public QueueRuntimeProperties(QueueProperties queueProperties)

Creates a new instance with runtime properties extracted from the given QueueDescription.

Parameters:

queueProperties - Queue description to extract runtime properties from.

Throws:

NullPointerException - if queueDescription is null.

Method Detail

getAccessedAt

public OffsetDateTime getAccessedAt()

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

Returns:

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

getActiveMessageCount

public int getActiveMessageCount()

Get the activeMessageCount property: Number of active messages in the queue, topic, or subscription.

Returns:

the activeMessageCount value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Gets the exact time the queue was created.

Returns:

The exact time the queue was created.

getDeadLetterMessageCount

public int getDeadLetterMessageCount()

Get the deadLetterMessageCount property: Number of messages that are dead lettered.

Returns:

the deadLetterMessageCount value.

getTotalMessageCount

public long getTotalMessageCount()

Gets the number of messages in the queue.

Returns:

The number of messages in the queue.

getName

public String getName()

Gets the name of the queue.

Returns:

The name of the queue.

getScheduledMessageCount

public int getScheduledMessageCount()

Get the scheduledMessageCount property: Number of scheduled messages.

Returns:

the scheduledMessageCount value.

getSizeInBytes

public long getSizeInBytes()

Gets the size of the queue, in bytes.

Returns:

The size of the queue, in bytes.

getTransferDeadLetterMessageCount

public int getTransferDeadLetterMessageCount()

Get the transferDeadLetterMessageCount property: Number of messages transferred into dead letters.

Returns:

the transferDeadLetterMessageCount value.

getTransferMessageCount

public int getTransferMessageCount()

Get the transferMessageCount property: Number of messages transferred to another queue, topic, or subscription.

Returns:

the transferMessageCount value.

getUpdatedAt

public OffsetDateTime getUpdatedAt()

Gets the exact time a message was updated in the queue.

Returns:

The exact time a message was updated in the queue.