TopicRuntimeProperties Class

  • java.lang.Object
    • com.azure.messaging.servicebus.administration.models.TopicRuntimeProperties

public final class TopicRuntimeProperties

Runtime properties about the topic.

Constructor Summary

Constructor Description
TopicRuntimeProperties(TopicProperties topicProperties)

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

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

int getCorrelationFilterCount()

Gets the total number of correlation filters across all subscriptions of the topic.

OffsetDateTime getCreatedAt()

Gets the exact time the queue was created.

String getName()

Gets the name of the topic.

int getScheduledMessageCount()

Get the scheduledMessageCount property: Number of scheduled messages.

long getSizeInBytes()

Gets the size of the topic, in bytes.

int getSqlFilterCount()

Gets the total number of SQL filters across all subscriptions of the topic.

int getSubscriptionCount()

Gets the number of subscriptions to the topic.

OffsetDateTime getUpdatedAt()

Gets the exact time the topic description was updated.

Methods inherited from java.lang.Object

Constructor Details

TopicRuntimeProperties

public TopicRuntimeProperties(TopicProperties topicProperties)

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

Parameters:

topicProperties - Topic description to extract runtime properties from.

Method Details

getAccessedAt

public OffsetDateTime getAccessedAt()

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

Returns:

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

getCorrelationFilterCount

public int getCorrelationFilterCount()

Gets the total number of correlation filters across all subscriptions of the topic.

The service supplies this count only from api-version 2024-05 onwards, and only in regions that have deployed the topic filter count feature. The value is 0 when the client targets an earlier ServiceBusServiceVersion or the region does not supply it.

Returns:

The total number of correlation filters across all subscriptions of the topic.

getCreatedAt

public OffsetDateTime getCreatedAt()

Gets the exact time the queue was created.

Returns:

The exact time the queue was created.

getName

public String getName()

Gets the name of the topic.

Returns:

The name of the topic.

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 topic, in bytes.

Returns:

The size of the topic, in bytes.

getSqlFilterCount

public int getSqlFilterCount()

Gets the total number of SQL filters across all subscriptions of the topic.

The service supplies this count only from api-version 2024-05 onwards, and only in regions that have deployed the topic filter count feature. The value is 0 when the client targets an earlier ServiceBusServiceVersion or the region does not supply it.

Returns:

The total number of SQL filters across all subscriptions of the topic.

getSubscriptionCount

public int getSubscriptionCount()

Gets the number of subscriptions to the topic.

Returns:

The number of subscriptions to the topic.

getUpdatedAt

public OffsetDateTime getUpdatedAt()

Gets the exact time the topic description was updated.

Returns:

The exact time the topic description was updated.

Applies to