Class DisplayData.Path
java.lang.Object
org.apache.beam.sdk.transforms.display.DisplayData.Path
- All Implemented Interfaces:
Serializable
- Enclosing class:
DisplayData
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 Summary
Modifier and TypeMethodDescriptionstatic DisplayData.Path
Construct a path from an absolute component path hierarchy.boolean
Extend the path by appending a sub-component path.Hierarchy list of component paths making up the full path, starting with the top-level child component path.int
hashCode()
static DisplayData.Path
root()
Path for display data registered by a top-level component.toString()
-
Method Details
-
root
Path for display data registered by a top-level component. -
absolute
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
Hierarchy list of component paths making up the full path, starting with the top-level child component path. For theroot
path, returns the empty list. -
extend
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 originatingDisplayData.Path
is not modified. -
toString
-
equals
-
hashCode
public int hashCode()
-