DisplayData.Item (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

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

Class DisplayData.Item<T>

  • java.lang.Object
    • com.google.cloud.dataflow.sdk.transforms.display.DisplayData.Item<T>
    • Method Detail

      • getNamespace

        @Nullable
        public String getNamespace()
        The namespace for the display item. The namespace defaults to the component which the display item belongs to.
      • getShortValue

        public Object getShortValue()
        Return the optional short value for an item, or null if none is provided.

        The short value is an alternative display representation for items having a long display value. For example, the value for DisplayData.Type.JAVA_CLASS items contains the full class name with package, while the short value contains just the class name.

        A value will be provided for each display item, and some types may also provide a short-value. If a short value is provided, display data consumers may choose to display it instead of or in addition to the value.

      • getLabel

        @Nullable
        public String getLabel()
        Retrieve the optional label for an item. The label is a human-readable description of what the metadata represents. UIs may choose to display the label instead of the item key.

        If no label was specified, this will return null.

      • getLinkUrl

        @Nullable
        public String getLinkUrl()
        Retrieve the optional link URL for an item. The URL points to an address where the reader can find additional context for the display data.

        If no URL was specified, this will return null.

      • withLabel

        public DisplayData.Item<T> withLabel(String label)
        Set the item label.

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

        This method does not alter the current instance, but instead returns a new DisplayData.Item with the label set.

      • withLinkUrl

        public DisplayData.Item<T> withLinkUrl(String url)
        Set the item link url.

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

        This method does not alter the current instance, but instead returns a new DisplayData.Item with the link url set.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object


Send feedback about...

Cloud Dataflow