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

Interface DisplayData.Builder

All Known Subinterfaces:

DisplayData.ItemBuilder

Enclosing class:

DisplayData

public static interface DisplayData.Builder

Utility to build up display metadata from a component and its included subcomponents.

Method Summary

Modifier and Type	Method and Description
DisplayData.ItemBuilder	add(String key, Class<?> value) Register the given class display metadata.
DisplayData.ItemBuilder	add(String key, double value) Register the given floating point display metadata.
DisplayData.ItemBuilder	add(String key, Duration value) Register the given duration display metadata.
DisplayData.ItemBuilder	add(String key, Instant value) Register the given timestamp display metadata.
DisplayData.ItemBuilder	add(String key, long value) Register the given numeric display metadata.
DisplayData.ItemBuilder	add(String key, String value) Register the given string display metadata.
DisplayData.Builder	include(HasDisplayData subComponent) Include display metadata from the specified subcomponent.

Method Detail

include

DisplayData.Builder include(HasDisplayData subComponent)

Include display metadata from the specified subcomponent. For example, a ParDo transform includes display metadata from the encapsulated DoFn.

Returns:

A builder instance to continue to build in a fluent-style.

add

DisplayData.ItemBuilder add(String key,
                            String value)

Register the given string display metadata. The metadata item will be registered with type DisplayData.Type.STRING, and is identified by the specified key and namespace from the current transform or component.

add

DisplayData.ItemBuilder add(String key,
                            long value)

Register the given numeric display metadata. The metadata item will be registered with type DisplayData.Type.INTEGER, and is identified by the specified key and namespace from the current transform or component.

add

DisplayData.ItemBuilder add(String key,
                            double value)

Register the given floating point display metadata. The metadata item will be registered with type DisplayData.Type.FLOAT, and is identified by the specified key and namespace from the current transform or component.

add

DisplayData.ItemBuilder add(String key,
                            Instant value)

Register the given timestamp display metadata. The metadata item will be registered with type DisplayData.Type.TIMESTAMP, and is identified by the specified key and namespace from the current transform or component.

add

DisplayData.ItemBuilder add(String key,
                            Duration value)

Register the given duration display metadata. The metadata item will be registered with type DisplayData.Type.DURATION, and is identified by the specified key and namespace from the current transform or component.

add

DisplayData.ItemBuilder add(String key,
                            Class<?> value)

Register the given class display metadata. The metadata item will be registered with type DisplayData.Type.JAVA_CLASS, and is identified by the specified key and namespace from the current transform or component.