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

Interface HasDisplayData

All Known Implementing Classes:

AvroIO.Read.Bound, AvroIO.Write.Bound, BigQueryIO.Read.Bound, BigQueryIO.Write.Bound, BigtableIO.Read, BigtableIO.Write, CoGroupByKey, Combine.Globally, Combine.GloballyAsSingletonView, Combine.GroupedValues, Combine.PerKey, Combine.PerKeyWithHotKeyFanout, Count.PerElement, CountingInput.BoundedCountingInput, CountingInput.UnboundedCountingInput, Create.TimestampedValues, Create.Values, DataflowPipelineRunner.StreamingPubsubIOWrite, DirectPipelineRunner.TestCombineDoFn, DoFn, Filter, FlatMapElements, Flatten.FlattenIterables, Flatten.FlattenPCollectionList, GroupByKey, GroupByKey.GroupAlsoByWindow, GroupByKey.GroupByKeyOnly, GroupByKey.ReifyTimestampsAndWindows, GroupByKey.SortValuesByTimestamp, IntraBundleParallelization.Bound, IntraBundleParallelization.MultiThreadedIntraBundleProcessingDoFn, Keys, KvSwap, MapElements, ParDo.Bound, ParDo.BoundMulti, Partition, PTransform, PubsubIO.Read.Bound, PubsubIO.Write.Bound, Read.Bounded, Read.Unbounded, RemoveDuplicates, RemoveDuplicates.WithRepresentativeValues, Sample.SampleAny, TextIO.Read.Bound, TextIO.Write.Bound, Values, View.AsIterable, View.AsList, View.AsMap, View.AsMultimap, View.AsSingleton, View.CreatePCollectionView, Window.Bound, Window.Remerge, WithKeys, WithTimestamps, Write.Bound

public interface HasDisplayData

Marker interface for PTransforms and components used within PTransforms to specify display metadata to be used within UIs and diagnostic tools.

Display metadata is optional and may be collected during pipeline construction. It should only be used to informational purposes. Tools and components should not assume that display data will always be collected, or that collected display data will always be displayed.

Method Summary

Modifier and Type	Method and Description
void	populateDisplayData(DisplayData.Builder builder) Register display metadata for the given transform or component.

Method Detail

populateDisplayData

void populateDisplayData(DisplayData.Builder builder)

Register display metadata for the given transform or component. Metadata can be registered directly on the provided builder, as well as via included sub-components.

 {@code

Parameters:

builder - The builder to populate with display metadata.