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

Class DisplayData.Path

java.lang.Object
org.apache.beam.sdk.transforms.display.DisplayData.Path
All Implemented Interfaces:
Serializable
Enclosing class:
DisplayData
public static class DisplayData.Path extends Object implements Serializable
Structured path of registered display data within a component hierarchy.

Display data items registered directly by a component will have the root path. If the component includes a sub-component, its display data will be registered at the path specified. Each sub-component path is created by appending a child element to the path of its parent component, forming a hierarchy.

See Also:

  • Method Details

    • root

      public static DisplayData.Path root()
      Path for display data registered by a top-level component.

    • absolute

      public static DisplayData.Path absolute(String firstPath, String... paths)
      Construct a path from an absolute component path hierarchy.

      For the root path, use root().

      Parameters:
      firstPath - Path of the first sub-component.
      paths - Additional path components.

    • getComponents

      public List<String> getComponents()
      Hierarchy list of component paths making up the full path, starting with the top-level child component path. For the root path, returns the empty list.

    • extend

      public DisplayData.Path extend(String path)
      Extend the path by appending a sub-component path. The new path element is added to the end of the path hierarchy.

      Returns a new DisplayData.Path instance; the originating DisplayData.Path is not modified.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object