Package com.azure.messaging.servicebus.administration.models

Class TopicProperties

java.lang.Object
com.azure.messaging.servicebus.administration.models.TopicProperties
public final class TopicProperties extends Object
Represents the static properties of the topic.
See Also:

  • Method Details

    • getName

      public String getName()
      Gets the name of the topic.
      Returns:
      The name of the topic;

    • getDefaultMessageTimeToLive

      public Duration getDefaultMessageTimeToLive()
      Get the defaultMessageTimeToLive property: 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.
      Returns:
      the defaultMessageTimeToLive value.

    • setDefaultMessageTimeToLive

      public TopicProperties setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
      Set the defaultMessageTimeToLive property: 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.
      Parameters:
      defaultMessageTimeToLive - the defaultMessageTimeToLive value to set.
      Returns:
      the TopicDescription object itself.

    • getMaxSizeInMegabytes

      public long getMaxSizeInMegabytes()
      Get the maxSizeInMegabytes property: The maximum size of the topic in megabytes, which is the size of memory allocated for the topic.
      Returns:
      the maxSizeInMegabytes value.

    • setMaxSizeInMegabytes

      public TopicProperties setMaxSizeInMegabytes(long maxSizeInMegabytes)
      Set the maxSizeInMegabytes property: The maximum size of the topic in megabytes, which is the size of memory allocated for the topic.
      Parameters:
      maxSizeInMegabytes - the maxSizeInMegabytes value to set.
      Returns:
      the TopicDescription object itself.

    • isDuplicateDetectionRequired

      public boolean isDuplicateDetectionRequired()
      Get the requiresDuplicateDetection property: A value indicating if this topic requires duplicate detection.
      Returns:
      the requiresDuplicateDetection value.

    • setDuplicateDetectionRequired

      public TopicProperties setDuplicateDetectionRequired(boolean requiresDuplicateDetection)
      Set the requiresDuplicateDetection property: A value indicating if this topic requires duplicate detection.
      Parameters:
      requiresDuplicateDetection - the requiresDuplicateDetection value to set.
      Returns:
      the TopicDescription object itself.

    • getDuplicateDetectionHistoryTimeWindow

      public Duration getDuplicateDetectionHistoryTimeWindow()
      Get the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
      Returns:
      the duplicateDetectionHistoryTimeWindow value.

    • setDuplicateDetectionHistoryTimeWindow

      public TopicProperties setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
      Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
      Parameters:
      duplicateDetectionHistoryTimeWindow - the duplicateDetectionHistoryTimeWindow value to set.
      Returns:
      the TopicDescription object itself.

    • isBatchedOperationsEnabled

      public boolean isBatchedOperationsEnabled()
      Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
      Returns:
      the enableBatchedOperations value.

    • getAuthorizationRules

      public List<AuthorizationRule> getAuthorizationRules()
      Get the authorizationRules property: Authorization rules for resource.
      Returns:
      the authorizationRules value.

    • getStatus

      public EntityStatus getStatus()
      Get the status property: Status of a Service Bus resource.
      Returns:
      the status value.

    • setStatus

      public TopicProperties setStatus(EntityStatus status)
      Set the status property: Status of a Service Bus resource.
      Parameters:
      status - the status value to set.
      Returns:
      the TopicDescription object itself.

    • isOrderingSupported

      public boolean isOrderingSupported()
      Get the supportOrdering property: A value that indicates whether the topic supports ordering.
      Returns:
      the supportOrdering value.

    • setOrderingSupported

      public TopicProperties setOrderingSupported(boolean supportOrdering)
      Set the supportOrdering property: A value that indicates whether the topic supports ordering.
      Parameters:
      supportOrdering - the supportOrdering value to set.
      Returns:
      the TopicDescription object itself.

    • getAutoDeleteOnIdle

      public Duration getAutoDeleteOnIdle()
      Get the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
      Returns:
      the autoDeleteOnIdle value.

    • setAutoDeleteOnIdle

      public TopicProperties setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
      Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
      Parameters:
      autoDeleteOnIdle - the autoDeleteOnIdle value to set.
      Returns:
      the TopicDescription object itself.

    • isPartitioningEnabled

      public boolean isPartitioningEnabled()
      Get the enablePartitioning property: A value that indicates whether the topic is to be partitioned across multiple message brokers.
      Returns:
      the enablePartitioning value.

    • getUserMetadata

      public String getUserMetadata()
      Get the userMetadata property: Metadata associated with the topic.
      Returns:
      the userMetadata value.

    • setUserMetadata

      public TopicProperties setUserMetadata(String userMetadata)
      Set the userMetadata property: Metadata associated with the topic.
      Parameters:
      userMetadata - the userMetadata value to set.
      Returns:
      the TopicDescription object itself.

    • getMaxMessageSizeInKilobytes

      public long getMaxMessageSizeInKilobytes()
      Get the maxMessageSizeInKilobytes property: The maximum size of a message in kilobytes.
      Returns:
      the maxMessageSizeInKilobytes value.

    • setMaxMessageSizeInKilobytes

      public TopicProperties setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes)
      Set the maxMessageSizeInKilobytes property: The maximum size of a message in kilobytes.
      Parameters:
      maxMessageSizeInKilobytes - the maxMessageSizeInKilobytes value to set.
      Returns:
      the QueueDescription object itself.