Class RootBrowsePublisher.ResultBuilder
java.lang.Object
com.inductiveautomation.historian.gateway.api.query.browsing.RootBrowsePublisher.ResultBuilder
- All Implemented Interfaces:
BrowsePublisher.NodeBuilder
- Enclosing class:
RootBrowsePublisher
protected class RootBrowsePublisher.ResultBuilder
extends Object
implements BrowsePublisher.NodeBuilder
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd()Adds the configured node to the results.creationTime(Instant creationTime) Sets when the node was created.displayPath(Path displayPath) Sets the human-readable display path.hasChildren(boolean hasChildren) Sets whether the node has child nodes.metadata(MetadataPoint metadata) Sets the node's metadata.retiredTime(Instant retiredTime) Sets when the node was retired.
-
Constructor Details
-
ResultBuilder
-
-
Method Details
-
creationTime
Description copied from interface:BrowsePublisher.NodeBuilderSets when the node was created.- Specified by:
creationTimein interfaceBrowsePublisher.NodeBuilder- Parameters:
creationTime- the creation time.- Returns:
- this builder.
-
retiredTime
Description copied from interface:BrowsePublisher.NodeBuilderSets when the node was retired.- Specified by:
retiredTimein interfaceBrowsePublisher.NodeBuilder- Parameters:
retiredTime- the retirement time.- Returns:
- this builder.
-
metadata
Description copied from interface:BrowsePublisher.NodeBuilderSets the node's metadata.- Specified by:
metadatain interfaceBrowsePublisher.NodeBuilder- Parameters:
metadata- the metadata point.- Returns:
- this builder.
-
displayPath
Description copied from interface:BrowsePublisher.NodeBuilderSets the human-readable display path.- Specified by:
displayPathin interfaceBrowsePublisher.NodeBuilder- Parameters:
displayPath- the display path.- Returns:
- this builder.
-
hasChildren
Description copied from interface:BrowsePublisher.NodeBuilderSets whether the node has child nodes.- Specified by:
hasChildrenin interfaceBrowsePublisher.NodeBuilder- Parameters:
hasChildren-trueif it does.- Returns:
- this builder.
-
add
public void add()Description copied from interface:BrowsePublisher.NodeBuilderAdds the configured node to the results.- Specified by:
addin interfaceBrowsePublisher.NodeBuilder
-