TopicName (Pulsar Common 2.10.0-rc-202110292205 API)

java.lang.Object
- org.apache.pulsar.common.naming.TopicName

All Implemented Interfaces:

ServiceUnitId
```
public class TopicName
extends Object
implements ServiceUnitId
```
Encapsulate the parsing of the completeTopicName name.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_NAMESPACE`
`static String`	`PARTITIONED_TOPIC_SUFFIX`
`static String`	`PUBLIC_TENANT`
`static TopicName`	`TRANSACTION_COORDINATOR_ASSIGN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static TopicName`	`get(String topic)`
`static TopicName`	`get(String domain, NamespaceName namespaceName, String topic)`
`static TopicName`	`get(String domain, String tenant, String namespace, String topic)`
`static TopicName`	`get(String domain, String tenant, String cluster, String namespace, String topic)`
`String`	`getCluster()` Deprecated.
`TopicDomain`	`getDomain()`
`String`	`getEncodedLocalName()`
`String`	`getLocalName()`
`String`	`getLookupName()` Get a string suitable for completeTopicName lookup.
`String`	`getNamespace()` Extract the namespace portion out of a completeTopicName name.
`NamespaceName`	`getNamespaceObject()` Get the namespace object that this completeTopicName belongs to.
`String`	`getNamespacePortion()`
`TopicName`	`getPartition(int index)`
`String`	`getPartitionedTopicName()` For partitions in a topic, return the base partitioned topic name.
`int`	`getPartitionIndex()`
`static int`	`getPartitionIndex(String topic)`
`String`	`getPersistenceNamingEncoding()` Returns the name of the persistence resource associated with the completeTopicName.
`String`	`getRestPath()` Returns the http rest path for use in the admin web service.
`String`	`getRestPath(boolean includeDomain)`
`String`	`getSchemaName()`
`String`	`getTenant()`
`int`	`hashCode()`
`boolean`	`includes(TopicName otherTopicName)` Check whether a fully-qualified topic is included in this `ServiceUnitId` object.
`boolean`	`isGlobal()`
`boolean`	`isPartitioned()`
`boolean`	`isPersistent()`
`boolean`	`isV2()` Returns true if this a V2 topic name prop/ns/topic-name.
`static boolean`	`isValid(String topic)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PUBLIC_TENANT
```
public static final String PUBLIC_TENANT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NAMESPACE
```
public static final String DEFAULT_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - PARTITIONED_TOPIC_SUFFIX
```
public static final String PARTITIONED_TOPIC_SUFFIX
```
    See Also:
    
    Constant Field Values
  - TRANSACTION_COORDINATOR_ASSIGN
```
public static final TopicName TRANSACTION_COORDINATOR_ASSIGN
```
- Method Detail
  - get
```
public static TopicName get(String domain,
                            NamespaceName namespaceName,
                            String topic)
```
  - get
```
public static TopicName get(String domain,
                            String tenant,
                            String namespace,
                            String topic)
```
  - get
```
public static TopicName get(String domain,
                            String tenant,
                            String cluster,
                            String namespace,
                            String topic)
```
  - get
```
public static TopicName get(String topic)
```
  - isValid
```
public static boolean isValid(String topic)
```
  - isPersistent
```
public boolean isPersistent()
```
  - getNamespace
```
public String getNamespace()
```
    Extract the namespace portion out of a completeTopicName name.
    Works both with old & new convention.
    
    Returns:
    
    the namespace
  - getNamespaceObject
```
public NamespaceName getNamespaceObject()
```
    Get the namespace object that this completeTopicName belongs to.
    
    Specified by:
    
    getNamespaceObject in interface ServiceUnitId
    
    Returns:
    
    namespace object
  - getDomain
```
public TopicDomain getDomain()
```
  - getTenant
```
public String getTenant()
```
  - getCluster
```
@Deprecated
public String getCluster()
```
    Deprecated.
  - getNamespacePortion
```
public String getNamespacePortion()
```
  - getLocalName
```
public String getLocalName()
```
  - getEncodedLocalName
```
public String getEncodedLocalName()
```
  - getPartition
```
public TopicName getPartition(int index)
```
  - getPartitionIndex
```
public int getPartitionIndex()
```
    Returns:
    
    partition index of the completeTopicName. It returns -1 if the completeTopicName (topic) is not partitioned.
  - isPartitioned
```
public boolean isPartitioned()
```
  - getPartitionedTopicName
```
public String getPartitionedTopicName()
```
    For partitions in a topic, return the base partitioned topic name. Eg:
    - persistent://prop/cluster/ns/my-topic-partition-1 --> persistent://prop/cluster/ns/my-topic
    - persistent://prop/cluster/ns/my-topic --> persistent://prop/cluster/ns/my-topic
  - getPartitionIndex
```
public static int getPartitionIndex(String topic)
```
    Returns:
    
    partition index of the completeTopicName. It returns -1 if the completeTopicName (topic) is not partitioned.
  - getRestPath
```
public String getRestPath()
```
    Returns the http rest path for use in the admin web service. Eg: * "persistent/my-tenant/my-namespace/my-topic" * "non-persistent/my-tenant/my-namespace/my-topic"
    
    Returns:
    
    topic rest path
  - getRestPath
```
public String getRestPath(boolean includeDomain)
```
  - getPersistenceNamingEncoding
```
public String getPersistenceNamingEncoding()
```
    Returns the name of the persistence resource associated with the completeTopicName.
    
    Returns:
    
    the relative path to be used in persistence
  - getLookupName
```
public String getLookupName()
```
    Get a string suitable for completeTopicName lookup.
    Example:
    persistent://tenant/cluster/namespace/completeTopicName -> persistent/tenant/cluster/namespace/completeTopicName
    
    Returns:
  - isGlobal
```
public boolean isGlobal()
```
  - getSchemaName
```
public String getSchemaName()
```
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface ServiceUnitId
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - includes
```
public boolean includes(TopicName otherTopicName)
```
    Description copied from interface: ServiceUnitId
    
    Check whether a fully-qualified topic is included in this ServiceUnitId object.
    
    Specified by:
    
    includes in interface ServiceUnitId
    
    Parameters:
    
    otherTopicName - a fully-qualified topic object
    
    Returns:
    
    true or false
  - isV2
```
public boolean isV2()
```
    Returns true if this a V2 topic name prop/ns/topic-name.
    
    Returns:
    
    true if V2

Class TopicName

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PUBLIC_TENANT

DEFAULT_NAMESPACE

PARTITIONED_TOPIC_SUFFIX

TRANSACTION_COORDINATOR_ASSIGN

Method Detail

get

get

get

get

isValid

isPersistent

getNamespace

getNamespaceObject

getDomain

getTenant

getCluster

getNamespacePortion

getLocalName

getEncodedLocalName

getPartition

getPartitionIndex

isPartitioned

getPartitionedTopicName

getPartitionIndex

getRestPath

getRestPath

getPersistenceNamingEncoding

getLookupName

isGlobal

getSchemaName

toString

equals

hashCode

includes

isV2