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

Interface DisplayData.ItemBuilder

All Superinterfaces:

DisplayData.Builder

Enclosing class:

DisplayData

public static interface DisplayData.ItemBuilder
extends DisplayData.Builder

Utility to append optional fields to display metadata, or register additional display metadata items.

Method Summary

Modifier and Type	Method and Description
DisplayData.ItemBuilder	withLabel(String label) Add a human-readable label to describe the most-recently added metadata field.
DisplayData.ItemBuilder	withLinkUrl(String url) Add a link URL to the most-recently added display metadata.

Methods inherited from interface com.google.cloud.dataflow.sdk.transforms.display.DisplayData.Builder

add, add, add, add, add, add, include

Method Detail

withLabel

DisplayData.ItemBuilder withLabel(@Nullable
                                  String label)

Add a human-readable label to describe the most-recently added metadata field. A label is optional; if unspecified, UIs should display the metadata key to identify the display item.

Specifying a null value will clear the label if it was previously defined.

withLinkUrl

DisplayData.ItemBuilder withLinkUrl(@Nullable
                                    String url)

Add a link URL to the most-recently added display metadata. A link URL is optional and can be provided to point the reader to additional details about the metadata.

Specifying a null value will clear the URL if it was previously defined.