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

Interface HasDisplayData

All Known Subinterfaces:
ApplicationNameOptions, AwsOptions, AzureOptions, BeamSqlDataCatalogExample.DCExamplePipelineOptions, BeamSqlPipelineOptions, BigQueryOptions, BigtableChangeStreamTestOptions, BlobstoreOptions, CloudResourceManagerOptions, CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>, CosmosOptions, DataCatalogPipelineOptions, DataflowPipelineDebugOptions, DataflowPipelineOptions, DataflowPipelineWorkerPoolOptions, DataflowProfilingOptions, DataflowStreamingPipelineOptions, DataflowWorkerHarnessOptions, DataflowWorkerLoggingOptions, DirectOptions, DirectTestOptions, ElasticsearchIOITCommon.ElasticsearchPipelineOptions, ExecutorOptions, ExpansionServiceOptions, ExperimentalOptions, FileStagingOptions, FirestoreOptions, FlinkPipelineOptions, GcpOptions, GcsOptions, GoogleAdsOptions, GoogleApiDebugOptions, HadoopFileSystemOptions, JetPipelineOptions, KafkaIO.Read.FakeFlinkPipelineOptions, KinesisIOOptions, ManualDockerEnvironmentOptions, MemoryMonitorOptions, MetricsOptions, PipelineOptions, PortablePipelineOptions, PrismPipelineOptions, PubsubOptions, PythonExternalTransformOptions, RemoteEnvironmentOptions, ResourceHintsOptions, S3Options, SdkHarnessOptions, SnowflakePipelineOptions, SpannerIO.SpannerChangeStreamOptions, SparkCommonPipelineOptions, SparkContextOptions, SparkPipelineOptions, SparkPortableStreamingPipelineOptions, SparkStructuredStreamingPipelineOptions, StreamingOptions, TestBigQueryOptions, TestDataflowPipelineOptions, TestPipeline.TestValueProviderOptions, TestPipelineOptions, TestPortablePipelineOptions, TestPrismPipelineOptions, TestPubsubOptions, TestSparkPipelineOptions, TestUniversalRunner.Options, Twister2PipelineOptions, VersionDependentFlinkPipelineOptions, WordCount.WordCountOptions
All Known Implementing Classes:
AddFields.Inner, AddShardKeyDoFn, AddUuidsTransform, AmqpIO.Read, AmqpIO.Write, AnnotateText, ApproximateCountDistinct.Globally, ApproximateCountDistinct.PerKey, ApproximateDistinct.ApproximateDistinctFn, ApproximateDistinct.GloballyDistinct, ApproximateDistinct.PerKeyDistinct, ApproximateQuantiles.ApproximateQuantilesCombineFn, ApproximateUnique.ApproximateUniqueCombineFn, ApproximateUnique.Globally, ApproximateUnique.PerKey, ArrayAgg.ArrayAggArray, AsJsons, AsJsons.AsJsonsWithFailures, AvroIO.Parse, AvroIO.ParseAll, AvroIO.ParseFiles, AvroIO.Read, AvroIO.ReadAll, AvroIO.ReadFiles, AvroIO.TypedWrite, AvroIO.Write, AvroSink, AvroSource, BatchStatefulParDoOverrides.BatchStatefulDoFn, BeamBuiltinAggregations.BitXOr, BeamBuiltinAnalyticFunctions.PositionAwareCombineFn, BeamImpulseSource, BeamJoinTransforms.JoinAsLookup, BeamRowToBigtableMutation, BeamRowToBigtableMutation.ToBigtableRowFn, BeamSetOperatorRelBase, BeamSetOperatorsTransforms.BeamSqlRow2KvFn, BeamSetOperatorsTransforms.SetOperatorFilteringDoFn, BeamSqlOutputToConsoleFn, BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransform, BigQueryExportReadSchemaTransformProvider.BigQueryExportSchemaTransform, BigQueryFileLoadsSchemaTransformProvider.BigQueryFileLoadsSchemaTransform, BigQueryIO.Read, BigQueryIO.TypedRead, BigQueryIO.Write, BigQueryStorageTableSource, BigQueryStorageWriteApiSchemaTransformProvider.BigQueryStorageWriteApiSchemaTransform, BigQueryWriteSchemaTransformProvider.BigQueryWriteSchemaTransform, BigtableIO.Read, BigtableIO.ReadChangeStream, BigtableIO.Write, BigtableIO.WriteWithResults, BigtableRowToBeamRow, BigtableRowToBeamRowFlat, BigtableWriteSchemaTransformProvider.GetMutationsFromBeamRow, BlockBasedSource, BoundedReadFromUnboundedSource, BoundedSource, CalendarWindows.DaysWindows, CalendarWindows.MonthsWindows, CalendarWindows.YearsWindows, CassandraIO.Read, CassandraIO.ReadAll, CassandraIO.Write, Cast, CdapIO.Read, CdapIO.Write, CleanUpReadChangeStreamDoFn, ClickHouseIO.Write, CloudVision.AnnotateImagesFromBytes, CloudVision.AnnotateImagesFromBytesWithContext, CloudVision.AnnotateImagesFromGcsUri, CloudVision.AnnotateImagesFromGcsUriWithContext, 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, CombineAsIterable, CombineFns.ComposedCombineFn, CombineFns.ComposedCombineFnWithContext, CombineWithContext.CombineFnWithContext, CompressedSource, ConsoleIO.Write.Unbound, ContextualTextIO.Read, ContextualTextIO.ReadFiles, CosmosIO.BoundedCosmosBDSource, CosmosIO.Read, CountIf.CountIfFn, CovarianceFn, Create.OfValueProvider, Create.TimestampedValues, Create.Values, Create.WindowedValues, CreateDataflowView, CreateStream, CreateStreamingSparkView, CreateStreamingSparkView.CreateSparkPCollectionView, CreateTables, CsvIO.Write, CsvIOParse, CsvWriteTransformProvider.CsvWriteTransform, DataflowGroupByKey, DataflowRunner.StreamingPCollectionViewWriterFn, DataframeTransform, DataGeneratorPTransform, DataGeneratorRowFn, DatastoreV1.DeleteEntity, DatastoreV1.DeleteEntityWithSummary, DatastoreV1.DeleteKey, DatastoreV1.DeleteKeyWithSummary, DatastoreV1.Read, DatastoreV1.Write, DatastoreV1.WriteWithSummary, DeadLetteredTransform, DebeziumIO.Read, Deduplicate.KeyedValues, Deduplicate.Values, Deduplicate.WithRepresentativeValues, DefaultSequenceCombiner, DetectNewPartitionsDoFn, DetectNewPartitionsDoFn, DicomIO.ReadStudyMetadata, Distinct, Distinct.WithRepresentativeValues, DLPDeidentifyText, DLPInspectText, DLPReidentifyText, DoFn, DropFields.Inner, DynamicAvroDestinations, DynamoDBIO.Read, DynamoDBIO.Write, ElasticsearchIO.BoundedElasticsearchSource, ElasticsearchIO.BulkIO, ElasticsearchIO.DocToBulk, ElasticsearchIO.Read, ElasticsearchIO.Write, EntityToRow, ErrorHandler.PTransformErrorHandler.WriteErrorMetrics, ErrorHandler.PTransformErrorHandler.WriteErrorMetrics.CountErrors, FhirIO.Deidentify, FhirIO.Deidentify.DeidentifyFn, FhirIO.ExecuteBundles, FhirIO.Export, FhirIO.Export.ExportResourcesFn, FhirIO.Import, FhirIO.Read, FhirIO.Search, FhirIO.Write, FhirIOPatientEverything, FileBasedSink, FileBasedSink.DynamicDestinations, FileBasedSource, FileIO.Match, FileIO.MatchAll, FileIO.MatchConfiguration, FileIO.ReadMatches, FileIO.Write, FillGaps, FillGaps.FillGapsDoFn, Filter, Filter.Inner, FilterForMutationDoFn, FirestoreV1.BatchGetDocuments, FirestoreV1.BatchWriteWithDeadLetterQueue, FirestoreV1.BatchWriteWithSummary, FirestoreV1.ListCollectionIds, FirestoreV1.ListDocuments, FirestoreV1.PartitionQuery, FirestoreV1.RunQuery, FixedWindows, FlatMapElements, FlatMapElements.FlatMapWithFailures, Flatten.Iterables, Flatten.PCollections, FlinkStreamingAggregationsTranslators.ConcatenateAsIterable, org.apache.beam.sdk.util.construction.ForwardingPTransform, GenerateSequence, GenerateSequenceSchemaTransformProvider.GenerateSequenceSchemaTransform, GlobalWindows, GoogleAdsV19.Read, GoogleAdsV19.ReadAll, Group.AggregateCombiner, Group.ByFields, Group.CombineFieldsByFields, Group.CombineFieldsGlobally, Group.CombineGlobally, Group.Global, GroupByEncryptedKey, GroupByKey, GroupIntoBatches, GroupIntoBatches.WithShardedKey, HadoopFormatIO.HadoopInputFormatBoundedSource, HadoopFormatIO.Read, HadoopFormatIO.Write, HBaseIO.Read, HBaseIO.ReadAll, HBaseIO.Write, HBaseIO.WriteRowMutations, HCatalogIO.Read, HCatalogIO.Write, HL7v2IO.HL7v2Read, HL7v2IO.HL7v2Read.FetchHL7v2Message, HL7v2IO.HL7v2Read.FetchHL7v2Message.HL7v2MessageGetFn, HL7v2IO.ListHL7v2Messages, HL7v2IO.Read, HL7v2IO.Read.FetchHL7v2Message, HL7v2IO.Read.FetchHL7v2Message.HL7v2MessageGetFn, HL7v2IO.Write, IcebergIO.ReadRows, IcebergIO.WriteRows, Impulse, InferableFunction, InfluxDbIO.Read, InfluxDbIO.Write, InitializeDoFn, InitializeDoFn, JavaExplodeTransformProvider.ExplodeTransform, JavaFilterTransformProvider.JavaFilterTransform, JavaMapToFieldsTransformProvider.JavaMapToFieldsTransform, JdbcIO.DataSourceProviderFromDataSourceConfiguration, JdbcIO.PoolableDataSourceProvider, JdbcIO.Read, JdbcIO.ReadAll, JdbcIO.ReadRows, JdbcIO.ReadWithPartitions, JdbcIO.Write, JdbcIO.WriteVoid, JdbcIO.WriteWithResults, JdbcReadSchemaTransformProvider.JdbcReadSchemaTransform, JdbcWriteSchemaTransformProvider.JdbcWriteSchemaTransform, JmsIO.Read, JmsIO.Write, Join.FullOuterJoin, Join.Impl, Join.InnerJoin, Join.LeftOuterJoin, Join.RightOuterJoin, JsonIO.Write, JsonToRow.JsonToRowWithErrFn, JsonToRow.JsonToRowWithErrFn.ParseWithError, JsonWriteTransformProvider.JsonWriteTransform, KafkaCommitOffset, KafkaIO.Read, KafkaIO.ReadSourceDescriptors, KafkaIO.TypedWithoutMetadata, KafkaIO.Write, KafkaIO.WriteRecords, KafkaReadRedistribute, KafkaReadSchemaTransformProvider.ErrorFn, KafkaSourceConsumerFn, Keys, KinesisIO.Read, KinesisIO.Write, KinesisTransformRegistrar.KinesisReadToBytes, KuduIO.Read, KuduIO.Write, KvSwap, LazyAggregateCombineFn, LoggingTransformProvider.LoggingTransform, Managed.ManagedTransform, MapElements, MapElements.MapWithFailures, MapKeys, MapValues, MicrobatchSource, MongoDbGridFSIO.Read, MongoDbGridFSIO.Read.BoundedGridFSSource, MongoDbGridFSIO.Write, MongoDbIO.Read, MongoDbIO.Write, MongoDbTable.DocumentToRow, MongoDbTable.RowToDocument, MqttIO.Read, MqttIO.Write, NaiveReadFromPulsarDoFn, Neo4jIO.DriverProviderFromDriverConfiguration, Neo4jIO.ReadAll, Neo4jIO.WriteUnwind, NonMergingWindowFn, OffsetBasedSource, OrderedEventProcessor, ParDo.MultiOutput, ParDo.SingleOutput, ParquetIO.Parse, ParquetIO.ParseFiles, ParquetIO.Read, ParquetIO.ReadFiles, ParseJsons, ParseJsons.ParseJsonsWithFailures, Partition, PartitioningWindowFn, PAssert.DefaultConcludeTransform, PAssert.GroupThenAssert, PAssert.GroupThenAssertForSingleton, PAssert.OneSideInputAssert, PeriodicImpulse, PeriodicSequence, PostProcessingMetricsDoFn, PreparePubsubWriteDoFn, PrepareWrite, PrimitiveParDoSingleFactory.ParDoSingle, ProtoFromBytes, ProtoToBytes, PTransform, PubsubIO.Read, PubsubIO.Write, PubsubIO.Write.PubsubBoundedWriter, PubsubLiteReadSchemaTransformProvider.ErrorFn, PubsubLiteSink, PubsubLiteWriteSchemaTransformProvider.ErrorCounterFn, PubsubLiteWriteSchemaTransformProvider.SetUuidFromPubSubMessage, PubsubLiteWriteSchemaTransformProvider.SetUuidFromPubSubMessage.SetUuidFn, PubsubUnboundedSink, PubsubUnboundedSource, PubsubWriteSchemaTransformProvider.ErrorFn, PulsarIO.Read, PulsarIO.Write, PythonExternalTransform, PythonMap, RabbitMqIO.Read, RabbitMqIO.Write, RampupThrottlingFn, Read.Bounded, Read.Unbounded, ReadAllViaFileBasedSource, ReadAllViaFileBasedSourceTransform, ReadAllViaFileBasedSourceTransform.AbstractReadFileRangesFn, ReadAllViaFileBasedSourceTransform.SplitIntoRangesFn, ReadAllViaFileBasedSourceWithFilename, ReadChangeStreamPartitionDoFn, ReadChangeStreamPartitionDoFn, ReadFromMySqlSchemaTransformProvider.MySqlReadSchemaTransform, ReadFromPostgresSchemaTransformProvider.PostgresReadSchemaTransform, ReadFromSqlServerSchemaTransformProvider.SqlServerReadSchemaTransform, ReadSpannerSchema, RecommendationAICreateCatalogItem, RecommendationAIImportCatalogItems, RecommendationAIImportUserEvents, RecommendationAIPredict, RecommendationAIWriteUserEvent, RecordToPublishResultDoFn, RedisIO.Read, RedisIO.ReadKeyPatterns, RedisIO.Write, RedisIO.WriteStreams, Redistribute.RedistributeArbitrarily, Redistribute.RedistributeByKey, 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, ReifyAsIterable, RenameFields.Inner, RequestResponseIO, Reshuffle, Reshuffle.AssignShardFn, Reshuffle.ViaRandomKey, RowToEntity, RpcQosOptions, RunInference, Sample.FixedSizedSampleFn, SchemaTransform, Select.Fields, Select.Flattened, Sessions, SimpleFunction, SingleStoreIO.Read, SingleStoreIO.ReadWithPartitions, SingleStoreIO.Write, SketchFrequencies.CountMinSketchFn, SketchFrequencies.GlobalSketch, SketchFrequencies.PerKeySketch, SlidingWindows, SnowflakeIO.Concatenate, SnowflakeIO.DataSourceProviderFromDataSourceConfiguration, SnowflakeIO.Read, SnowflakeIO.Read.CleanTmpFilesFromGcsFn, SnowflakeIO.Read.MapCsvToStringArrayFn, SnowflakeIO.Write, SnsIO.Write, SolaceIO.Read, SolaceIO.Write, SolrIO.Read, SolrIO.ReadAll, SolrIO.Write, SortValues, Source, SpannerChangestreamsReadSchemaTransformProvider.DataChangeRecordToRow, SpannerIO.CreateTransaction, SpannerIO.Read, SpannerIO.ReadAll, SpannerIO.ReadChangeStream, SpannerIO.Write, SpannerIO.WriteGrouped, SpannerReadSchemaTransformProvider.ErrorFn, SparkReceiverIO.Read, SplunkIO.Write, SqlTransform, SqsIO.Read, SqsIO.Write, SqsIO.WriteBatches, StorageApiConvertMessages, StorageApiConvertMessages.ConvertMessagesDoFn, StorageApiFlushAndFinalizeDoFn, StorageApiLoads, StorageApiWriteRecordsInconsistent, StorageApiWritesShardedRecords, StorageApiWriteUnshardedRecords, StreamingInserts, StreamingWriteTables, StringAgg.StringAggByte, StringAgg.StringAggString, SubscribeTransform, TDigestQuantiles.GlobalDigest, TDigestQuantiles.PerKeyDigest, TDigestQuantiles.TDigestQuantilesFn, Tee, TestStream, TextIO.Read, TextIO.ReadAll, TextIO.ReadFiles, TextIO.TypedWrite, TextIO.Write, TextSource, TextTableProvider.CsvToRow, TextTableProvider.LinesReadConverter, TextTableProvider.LinesWriteConverter, TFRecordIO.Read, TFRecordIO.ReadFiles, TFRecordIO.Write, TFRecordReadSchemaTransformProvider.ErrorFn, TFRecordWriteSchemaTransformProvider.ErrorFn, ThriftIO.ReadFiles, TikaIO.Parse, TikaIO.ParseFiles, ToJson, Top.TopCombineFn, TVFSlidingWindowFn, TypedCombineFnDelegate, UnboundedBatchedSolaceWriter, UnboundedSolaceSource, UnboundedSolaceWriter, UnboundedSource, UnboundedSourceImpl, UnboundedStreamingSolaceWriter, UpdateSchemaDestination, UuidDeduplicationTransform, Values, ValueWithRecordId.StripIdsDoFn, VarianceFn, VideoIntelligence.AnnotateVideoFromBytes, VideoIntelligence.AnnotateVideoFromBytesWithContext, VideoIntelligence.AnnotateVideoFromUri, VideoIntelligence.AnnotateVideoFromURIWithContext, 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, WordCount.CountWords, WordCount.FormatAsTextFn, WriteFiles, WriteToMySqlSchemaTransformProvider.MySqlWriteSchemaTransform, WriteToPostgresSchemaTransformProvider.PostgresWriteSchemaTransform, WriteToPulsarDoFn, WriteToSqlServerSchemaTransformProvider.SqlServerWriteSchemaTransform, XmlIO.Read, XmlIO.ReadFiles, XmlIO.Write, XmlSource, YamlTransform
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:

  • Method Summary

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

  • Method Details

    • 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: