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

Class DisplayData

java.lang.Object

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

public class DisplayData
extends Object

Static display metadata associated with a pipeline component. Display data is useful for pipeline runner UIs and diagnostic dashboards to display details about PTransforms that make up a pipeline.

Components specify their display data by implementing the HasDisplayData interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DisplayData.Builder Utility to build up display metadata from a component and its included subcomponents.
static class	DisplayData.Identifier Unique identifier for a display metadata item within a component.
static class	DisplayData.Item A display metadata item.
static interface	DisplayData.ItemBuilder Utility to append optional fields to display metadata, or register additional display metadata items.

Method Summary

Modifier and Type	Method and Description
Map<DisplayData.Identifier,DisplayData.Item>	asMap()
static DisplayData	from(HasDisplayData component) Collect the DisplayData from a component.
Collection<DisplayData.Item>	items()
static DisplayData	none() Default empty DisplayData instance.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

none

public static DisplayData none()

Default empty DisplayData instance.

from

public static DisplayData from(HasDisplayData component)

Collect the DisplayData from a component. This will traverse all subcomponents specified via DisplayData.Builder.include(com.google.cloud.dataflow.sdk.transforms.display.HasDisplayData) in the given component. Data in this component will be in a namespace derived from the component.

items

public Collection<DisplayData.Item> items()

asMap

public Map<DisplayData.Identifier,DisplayData.Item> asMap()

toString

public String toString()

Overrides:

toString in class Object