- All Known Subinterfaces:
LogicalGraphInstance
public interface LogicalGraphInstanceView
A read-only super-interface of
LogicalGraphInstance- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionList<? extends OperatorInstance>Gets the descriptions of the top-level operators comprising the instance.Uniquely identifies this graph instance, currently used for ui refresh on the clientgetName()Returns the name of this graph instance.getPath()Returns the base path of this graph instance.Returns a snapshot that reflects a point-in-time of this graph instancegetState()Gets the current execution state of the instance.
-
Method Details
-
getGraphInstanceGUID
GUID getGraphInstanceGUID()Uniquely identifies this graph instance, currently used for ui refresh on the client- Returns:
- a unique identifier for this graph instance
-
getState
GraphState getState()Gets the current execution state of the instance.- Returns:
- the current state
-
getName
String getName()Returns the name of this graph instance. This will be the same as thenameof the correspondingLogicalGraph.- Returns:
- the name of this graph instance.
-
getPath
GraphPath getPath()Returns the base path of this graph instance. This will be the same asgetName()for top-level graphs. For subgraphs, this will include the path of the operator/connection that launched the graph.- Returns:
- the base path of this graph instance.
-
getChildren
List<? extends OperatorInstance> getChildren()Gets the descriptions of the top-level operators comprising the instance.- Returns:
- the list of operator descriptors described by the instance
-
getSnapshot
LogicalGraphInstanceView getSnapshot()Returns a snapshot that reflects a point-in-time of this graph instance- Returns:
- a snapshot that reflects a point-in-time of this graph instance
-