Package org.apache.beam.sdk.transforms.display

Interface HasDisplayData

All Known Subinterfaces:

ApplicationNameOptions, CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>, ExecutorOptions, ExperimentalOptions, FileStagingOptions, ManualDockerEnvironmentOptions, MetricsOptions, PipelineOptions, PortablePipelineOptions, RemoteEnvironmentOptions, ResourceHintsOptions, SdkHarnessOptions, StreamingOptions, TestPipeline.TestValueProviderOptions, TestPipelineOptions

All Known Implementing Classes:

AddFields.Inner, ApproximateQuantiles.ApproximateQuantilesCombineFn, ApproximateUnique.ApproximateUniqueCombineFn, ApproximateUnique.Globally, ApproximateUnique.PerKey, AvroIO.Parse, AvroIO.ParseAll, AvroIO.ParseFiles, AvroIO.Read, AvroIO.ReadAll, AvroIO.ReadFiles, AvroIO.TypedWrite, AvroIO.Write, AvroSink, AvroSource, BlockBasedSource, BoundedReadFromUnboundedSource, BoundedSource, CalendarWindows.DaysWindows, CalendarWindows.MonthsWindows, CalendarWindows.YearsWindows, Cast, CoGroup.ExpandCrossProduct, CoGroup.Impl, CoGroupByKey, Combine.AccumulatingCombineFn, Combine.BinaryCombineDoubleFn, Combine.BinaryCombineFn, Combine.BinaryCombineIntegerFn, Combine.BinaryCombineLongFn, Combine.CombineFn, Combine.Globally, Combine.GloballyAsSingletonView, Combine.GroupedValues, Combine.IterableCombineFn, Combine.PerKey, Combine.PerKeyWithHotKeyFanout, Combine.SimpleCombineFn, CombineFns.ComposedCombineFn, CombineFns.ComposedCombineFnWithContext, CombineWithContext.CombineFnWithContext, CompressedSource, Create.OfValueProvider, Create.TimestampedValues, Create.Values, DeadLetteredTransform, Deduplicate.KeyedValues, Deduplicate.Values, Deduplicate.WithRepresentativeValues, Distinct, Distinct.WithRepresentativeValues, DoFn, DropFields.Inner, DynamicAvroDestinations, FileBasedSink, FileBasedSink.DynamicDestinations, FileBasedSource, FileIO.Match, FileIO.MatchAll, FileIO.MatchConfiguration, FileIO.ReadMatches, FileIO.Write, Filter, Filter.Inner, FixedWindows, FlatMapElements, FlatMapElements.FlatMapWithFailures, Flatten.Iterables, Flatten.PCollections, GenerateSequence, GlobalWindows, Group.AggregateCombiner, Group.ByFields, Group.CombineFieldsByFields, Group.CombineFieldsGlobally, Group.CombineGlobally, Group.Global, GroupByKey, GroupIntoBatches, GroupIntoBatches.WithShardedKey, IdentityWindowFn, Impulse, InferableFunction, Join.Impl, JsonToRow.JsonToRowWithErrFn, JsonToRow.JsonToRowWithErrFn.ParseWithError, Keys, KvSwap, MapElements, MapElements.MapWithFailures, MapKeys, MapValues, NonMergingWindowFn, OffsetBasedSource, ParDo.MultiOutput, ParDo.SingleOutput, Partition, PartitioningWindowFn, PAssert.DefaultConcludeTransform, PAssert.GroupThenAssert, PAssert.GroupThenAssertForSingleton, PAssert.OneSideInputAssert, PeriodicImpulse, PeriodicSequence, PTransform, Read.Bounded, Read.Unbounded, ReadAllViaFileBasedSource, Regex.AllMatches, Regex.Find, Regex.FindAll, Regex.FindKV, Regex.FindName, Regex.FindNameKV, Regex.Matches, Regex.MatchesKV, Regex.MatchesName, Regex.MatchesNameKV, Regex.ReplaceAll, Regex.ReplaceFirst, Regex.Split, RenameFields.Inner, Reshuffle, Reshuffle.AssignShardFn, Reshuffle.ViaRandomKey, Sample.FixedSizedSampleFn, Select.Fields, Select.Flattened, Sessions, SimpleFunction, SlidingWindows, Source, TestStream, TextIO.Read, TextIO.ReadAll, TextIO.ReadFiles, TextIO.TypedWrite, TextIO.Write, TFRecordIO.Read, TFRecordIO.ReadFiles, TFRecordIO.Write, ToJson, Top.TopCombineFn, UnboundedSource, Values, ValueWithRecordId.StripIdsDoFn, View.AsIterable, View.AsList, View.AsMap, View.AsMultimap, View.AsSingleton, View.CreatePCollectionView, View.ToListViewDoFn, Wait.OnSignal, Watch.Growth, Watch.WatchGrowthFn, Window, Window.Assign, WindowFn, WithFailures.ExceptionAsMapHandler, WithFailures.ThrowableHandler, WithKeys, WithKeys, WithTimestamps, WriteFiles

public interface HasDisplayData

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

Display data is registered by overriding populateDisplayData(DisplayData.Builder) in a component which implements HasDisplayData. Display data is available for PipelineOptions and PTransform implementations.

@Override
 public void populateDisplayData(DisplayData.Builder builder) {
  super.populateDisplayData(builder);

  builder
     .include(subComponent)
     .add(DisplayData.item("minFilter", 42))
     .addIfNotDefault(DisplayData.item("useTransactions", this.txn), false)
     .add(DisplayData.item("topic", "projects/myproject/topics/mytopic")
       .withLabel("Pub/Sub Topic"))
     .add(DisplayData.item("serviceInstance", "myservice.com/fizzbang")
       .withLinkUrl("http://www.myservice.com/fizzbang"));
 }
 

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

See Also:

populateDisplayData(DisplayData.Builder)

Method Summary

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

Method Detail

populateDisplayData

void populateDisplayData(DisplayData.Builder builder)

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData