com.google.cloud.pubsub

Class TopicId

java.lang.Object

com.google.cloud.pubsub.TopicId

All Implemented Interfaces:

Serializable

public final class TopicId
extends Object
implements Serializable

Identity for a Google PubSub topic. A TopicId object can be used to create subscriptions for topics that possibly reside in different projects.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static TopicId	deletedTopic() Returns the identity of a deleted topic.
boolean	equals(Object obj)
int	hashCode()
boolean	isDeleted() Returns true if this object is the identity of a deleted topic, false otherwhise.
static TopicId	of(String topic) Returns a topic identity given the topic name.
static TopicId	of(String project, String topic) Returns a topic identity given project and topic names.
String	project() Returns the name of the project where the topic resides.
String	topic() Returns the name of the topic.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

project

public String project()

Returns the name of the project where the topic resides. If null the topic is assumed to reside in the ServiceOptions.projectId() project.

topic

public String topic()

Returns the name of the topic.

isDeleted

public boolean isDeleted()

Returns true if this object is the identity of a deleted topic, false otherwhise. If isDeleted() is true, topic() returns "_deleted-topic_" and project() returns null.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

deletedTopic

public static TopicId deletedTopic()

Returns the identity of a deleted topic. The deleted topic is such that isDeleted() returns true, topic() returns "_is_deleted_" and project() returns null.

of

public static TopicId of(String topic)

Returns a topic identity given the topic name.

of

public static TopicId of(String project,
         String topic)

Returns a topic identity given project and topic names.