co.cask.cdap.messaging

Class TopicMetadata

java.lang.Object

co.cask.cdap.messaging.TopicMetadata

public class TopicMetadata
extends Object

Represents metadata about a messaging topic.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERATION_KEY
static String	TTL_KEY

Constructor Summary

Constructors

Constructor and Description
TopicMetadata(co.cask.cdap.proto.id.TopicId topicId, Map<String,String> properties) Creates a new instance for the given topic with the associated properties.
TopicMetadata(co.cask.cdap.proto.id.TopicId topicId, Map<String,String> properties, boolean validate) Creates a new instance for the given topic with the associated properties.
TopicMetadata(co.cask.cdap.proto.id.TopicId topicId, Object... properties) Creates a new instance for the given topic with the associated properties.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
boolean	exists() Check whether the topic exists.
int	getGeneration() Returns the generation id for the topic.
Map<String,String>	getProperties() Returns the raw properties for the topic.
co.cask.cdap.proto.id.TopicId	getTopicId() Returns the topic id that this metadata is associated with.
long	getTTL() Returns the time-to-live in seconds property of the topic.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GENERATION_KEY

public static final String GENERATION_KEY

See Also:

Constant Field Values

TTL_KEY

public static final String TTL_KEY

See Also:

Constant Field Values

Constructor Detail

TopicMetadata

public TopicMetadata(co.cask.cdap.proto.id.TopicId topicId,
                     Map<String,String> properties)

Creates a new instance for the given topic with the associated properties.

TopicMetadata

public TopicMetadata(co.cask.cdap.proto.id.TopicId topicId,
                     Map<String,String> properties,
                     boolean validate)

Creates a new instance for the given topic with the associated properties. The properties provided can optionally be validated to see if it contains valid values for all required properties.

Throws:

IllegalArgumentException - if validate is true and the provided properties is not valid.

TopicMetadata

public TopicMetadata(co.cask.cdap.proto.id.TopicId topicId,
                     Object... properties)

Creates a new instance for the given topic with the associated properties.

Parameters:

topicId - topic id

properties - a list of key/value pairs that will get converted into a Map.

Method Detail

getTopicId

public co.cask.cdap.proto.id.TopicId getTopicId()

Returns the topic id that this metadata is associated with.

getProperties

public Map<String,String> getProperties()

Returns the raw properties for the topic.

getGeneration

public int getGeneration()

Returns the generation id for the topic.

exists

public boolean exists()

Check whether the topic exists.

getTTL

public long getTTL()

Returns the time-to-live in seconds property of the topic.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object