Share via

SubscriptionRuntimeProperties Class

  • Reference
Package:
com.azure.messaging.servicebus.administration.models
Maven Artifact:
com.azure:azure-messaging-servicebus:7.17.6
  • java.lang.Object
    • com.azure.messaging.servicebus.administration.models.SubscriptionRuntimeProperties

public class SubscriptionRuntimeProperties

Runtime properties about a subscription.

Constructor Summary

Constructor Description
SubscriptionRuntimeProperties(SubscriptionProperties subscriptionProperties)

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

Method Summary

Modifier and Type Method and Description
OffsetDateTime getAccessedAt()

Gets the last time the subscription was accessed.
int getActiveMessageCount()

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

Gets the exact time the subscription was created.
int getDeadLetterMessageCount()

Get the deadLetterMessageCount property: Number of messages that are dead lettered.
String getSubscriptionName()

Gets the name of the subscription.
String getTopicName()

Gets the name of the topic this subscription is associated with.
long getTotalMessageCount()

Gets the number of messages in the subscription.
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 the subscription was updated.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SubscriptionRuntimeProperties

public SubscriptionRuntimeProperties(SubscriptionProperties subscriptionProperties)

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

Parameters:

subscriptionProperties - Subscription description to extract runtime properties from.

Method Details

getAccessedAt

public OffsetDateTime getAccessedAt()

Gets the last time the subscription was accessed.

Returns:

The last time the subscription was accessed.

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 subscription was created.

Returns:

The exact time the subscription was created.

getDeadLetterMessageCount

public int getDeadLetterMessageCount()

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

Returns:

the deadLetterMessageCount value.

getSubscriptionName

public String getSubscriptionName()

Gets the name of the subscription.

Returns:

The name of the subscription.

getTopicName

public String getTopicName()

Gets the name of the topic this subscription is associated with.

Returns:

The name of the topic this subscription is associated with.

getTotalMessageCount

public long getTotalMessageCount()

Gets the number of messages in the subscription.

Returns:

The number of messages in the subscription.

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 the subscription was updated.

Returns:

The exact time the subscription was updated.

Applies to