DisplayData.Path (core 2.44.0 API)

java.lang.Object
- org.apache.beam.sdk.transforms.display.DisplayData.Path

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

DisplayData
```
public static class DisplayData.Path
extends java.lang.Object
implements java.io.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:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DisplayData.Path`	`absolute(java.lang.String firstPath, java.lang.String... paths)`	Construct a path from an absolute component path hierarchy.
`boolean`	`equals(@Nullable java.lang.Object obj)`
`DisplayData.Path`	`extend(java.lang.String path)`	Extend the path by appending a sub-component path.
`java.util.List<java.lang.String>`	`getComponents()`	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.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - root
```
public static DisplayData.Path root()
```
    Path for display data registered by a top-level component.
  - absolute
```
public static DisplayData.Path absolute(java.lang.String firstPath,
                                        java.lang.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 java.util.List<java.lang.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(java.lang.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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(@Nullable java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object