SBTopicProperties Class
The Topic Properties definition.
Constructor
SBTopicProperties(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
size_in_bytes
|
Size of the topic, in bytes. |
|
created_at
|
Exact time the message was created. |
|
updated_at
|
The exact time the message was updated. |
|
accessed_at
|
Last time the message was sent, or a request was received, for this topic. |
|
subscription_count
|
Number of subscriptions. |
|
count_details
|
Message count details. |
|
default_message_time_to_live
|
ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
|
max_size_in_megabytes
|
Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. |
|
max_message_size_in_kilobytes
|
Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. |
|
requires_duplicate_detection
|
Value indicating if this topic requires duplicate detection. |
|
duplicate_detection_history_time_window
|
ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
|
enable_batched_operations
|
Value that indicates whether server-side batched operations are enabled. |
|
status
|
str or
EntityStatus
Enumerates the possible values for the status of a messaging entity. Known values are: "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", and "Unknown". |
|
support_ordering
|
Value that indicates whether the topic supports ordering. |
|
auto_delete_on_idle
|
ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. |
|
enable_partitioning
|
Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. |
|
enable_express
|
Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. |
|
user_metadata
|
Gets and Sets Metadata of User. |
Attributes
accessed_at
Last time the message was sent, or a request was received, for this topic.
accessed_at: datetime | None
auto_delete_on_idle
ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
auto_delete_on_idle: timedelta | None
count_details
Message count details.
count_details: _models.MessageCountDetails | None
created_at
Exact time the message was created.
created_at: datetime | None
default_message_time_to_live
ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
default_message_time_to_live: timedelta | None
duplicate_detection_history_time_window
ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
duplicate_detection_history_time_window: timedelta | None
enable_batched_operations
Value that indicates whether server-side batched operations are enabled.
enable_batched_operations: bool | None
enable_express
Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
enable_express: bool | None
enable_partitioning
Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
enable_partitioning: bool | None
max_message_size_in_kilobytes
Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.
max_message_size_in_kilobytes: int | None
max_size_in_megabytes
Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
max_size_in_megabytes: int | None
requires_duplicate_detection
Value indicating if this topic requires duplicate detection.
requires_duplicate_detection: bool | None
size_in_bytes
Size of the topic, in bytes.
size_in_bytes: int | None
status
Enumerates the possible values for the status of a messaging entity. Known values are: "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", and "Unknown".
status: str | _models.EntityStatus | None
subscription_count
Number of subscriptions.
subscription_count: int | None
support_ordering
Value that indicates whether the topic supports ordering.
support_ordering: bool | None
updated_at
The exact time the message was updated.
updated_at: datetime | None
user_metadata
Gets and Sets Metadata of User.
user_metadata: str | None