com.google.cloud.dataflow.sdk.transforms.display

Class DisplayData.Item

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.display.DisplayData.Item

Enclosing class:

DisplayData

public static class DisplayData.Item
extends Object

A display metadata item. DisplayData items are registered via DisplayData.Builder.add(java.lang.String, java.lang.String) within HasDisplayData.populateDisplayData(com.google.cloud.dataflow.sdk.transforms.display.DisplayData.Builder) implementations. Each metadata item is uniquely identified by the specified key and namespace generated from the registering component's class name.

Method Summary

Modifier and Type	Method and Description
String	getKey()
String	getLabel() Retrieve the optional label for an item.
String	getLinkUrl() Retrieve the optional link URL for an item.
String	getNamespace()
String	getShortValue() Return the optional short value for an item.
com.google.cloud.dataflow.sdk.transforms.display.DisplayData.Type	getType() Retrieve the DisplayData.Type of display metadata.
String	getValue() Retrieve the value of the metadata item.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getNamespace

public String getNamespace()

getKey

public String getKey()

getType

public com.google.cloud.dataflow.sdk.transforms.display.DisplayData.Type getType()

Retrieve the DisplayData.Type of display metadata. All metadata conforms to a predefined set of allowed types.

getValue

public String getValue()

Retrieve the value of the metadata item.

getShortValue

@Nullable
public String getShortValue()

Return the optional short value for an item. Types may provide a short-value to displayed instead of or in addition to the full value.

Some display data types will not provide a short value, in which case the return value will be null.

getLabel

@Nullable
public String getLabel()

Retrieve the optional label for an item. The label is a human-readable description of what the metadata represents. UIs may choose to display the label instead of the item key.

If no label was specified, this will return null.

getLinkUrl

@Nullable
public String getLinkUrl()

Retrieve the optional link URL for an item. The URL points to an address where the reader can find additional context for the display metadata.

If no URL was specified, this will return null.

toString

public String toString()

Overrides:

toString in class Object