org.apache.beam.sdk.transforms.display

Class DisplayData.Identifier

java.lang.Object

org.apache.beam.sdk.transforms.display.DisplayData.Identifier

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

DisplayData

public abstract static class DisplayData.Identifier
extends java.lang.Object
implements java.io.Serializable

Unique identifier for a display data item within a component.

Identifiers are composed of:

• A path based on the component hierarchy
• The key it is registered with
• A namespace generated from the class of the component which registered the item.

Display data registered with the same key from different components will have different namespaces and thus will both be represented in the composed DisplayData. If a single component registers multiple metadata items with the same key, only the most recent item will be retained; previous versions are discarded.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Identifier()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getKey()
abstract java.lang.Class<?>	getNamespace()
abstract DisplayData.Path	getPath()
static DisplayData.Identifier	of(DisplayData.Path path, java.lang.Class<?> namespace, java.lang.String key)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Identifier

public Identifier()

Method Detail

getPath

public abstract DisplayData.Path getPath()

getNamespace

public abstract java.lang.Class<?> getNamespace()

getKey

public abstract java.lang.String getKey()

of

public static DisplayData.Identifier of(DisplayData.Path path,
                                        java.lang.Class<?> namespace,
                                        java.lang.String key)

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object