Package org.springframework.pulsar.core

Record Class PulsarTopic

java.lang.Object
java.lang.Record
org.springframework.pulsar.core.PulsarTopic
Record Components:
topicName - the fully qualified topic name in the format 'domain://tenant/namespace/name'
numberOfPartitions - the number of partitions, or 0 for non-partitioned topics
public record PulsarTopic(String topicName, int numberOfPartitions) extends Record
Represents a Pulsar topic.

The input topicName must be fully-qualified. As such, it is recommended to use the PulsarTopicBuilder to create instances like this: 


 	PulsarTopic topic = new PulsarTopicBuilder().name("my-topic").build();
The builder is more lenient and allows non-fully-qualified topic names to be input and fully qualifies the output name using its configured default tenant and namepsace.
Author:
Alexander Preuß, Chris Bono
See Also:

  • Constructor Details

    • PulsarTopic

      public PulsarTopic(String topicName, int numberOfPartitions)
      Creates an instance of a PulsarTopic record class.
      Parameters:
      topicName - the value for the topicName record component
      numberOfPartitions - the value for the numberOfPartitions record component

  • Method Details

    • builder

      @Deprecated(since="1.2.0", forRemoval=true) public static PulsarTopicBuilder builder(String topicName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1.2.0 for removal in 1.4.0 in favor of PulsarTopicBuilder() or PulsarTopicBuilder(TopicDomain, String, String)
      Convenience method to create a topic builder with the specified topic name.
      Parameters:
      topicName - the name of the topic
      Returns:
      the topic builder instance

    • isPartitioned

      public boolean isPartitioned()
      Checks if the topic is partitioned.
      Returns:
      true if the topic is partitioned

    • getComponents

      public org.springframework.pulsar.core.PulsarTopic.TopicComponents getComponents()
      Get the individual identifying components of a Pulsar topic.
      Returns:
      PulsarTopic.TopicComponents

    • getFullyQualifiedTopicName

      @Deprecated(since="1.2.0", forRemoval=true) public String getFullyQualifiedTopicName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of version 1.2.0 topicName must always be fully qualified, use topicName() instead.
      Get the fully-qualified name of this topic in the format domain://tenant/namespace/name where the components have the following defaults when not specified in the original topic name used to build this topic. 
       - domain is one of ('persistent', 'non-persistent') with a default of 'persistent'
 - tenant has default of 'public'
 - namespace has default of 'default'
      Returns:
      the fully-qualified topic name

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • topicName

      public String topicName()
      Returns the value of the topicName record component.
      Returns:
      the value of the topicName record component

    • numberOfPartitions

      public int numberOfPartitions()
      Returns the value of the numberOfPartitions record component.
      Returns:
      the value of the numberOfPartitions record component