public interface SfcScriptingFunctions
Modifier and Type | Method and Description |
---|---|
void |
cancelChart(java.util.UUID instanceId)
Cancels the chart instance indicated by
instanceId . |
void |
debugResume(java.util.UUID instanceId)
Sends a message to the chart instance stopped at a breakpoint to resume normal operations.
|
void |
debugStep(java.util.UUID instanceId)
Sends a message to the chart instance stopped at a breakpoint to step to the next step.
|
java.util.List<ChartInfo> |
getRunningCharts()
Returns information about the currently running charts.
|
java.util.List<ChartInfo> |
getRunningCharts(java.lang.String chartPath)
Returns information about the currently running instances of a given chart path.
|
PyChartScope |
getVariables(java.util.UUID instanceId)
Returns the chart scope for the specified instance.
|
void |
pauseChart(java.util.UUID instanceId)
Pause the chart instance indicated by
instanceId . |
void |
redundantCheckpoint(java.util.UUID instanceId)
For charts that have the "redundancy sync" setting enabled, this method synchronizes chart and step variables
of the specified chart instance across the redundant cluster, allowing the instance to continue where it left
off if a redundant failover occurs.
|
void |
resumeChart(java.util.UUID instanceId)
Resume the chart instance indicated by
instanceId . |
void |
setVariables(java.util.UUID instanceId,
org.python.core.PyObject variableMap)
Updates the chart indicated by
instanceId by copying all of the variables
from the provided variableMap into the chart's scope. |
void |
setVariables(java.util.UUID instanceId,
java.util.UUID stepId,
org.python.core.PyObject variableMap) |
java.util.UUID |
startChart(java.lang.String chartPath,
java.util.Map<java.lang.String,java.lang.Object> parameters)
Start a chart from the definition at
chartPath . |
java.util.UUID startChart(java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.Exception
chartPath
.chartPath
- the path to the chart definition.parameters
- the parameters passed to the chart scope.UUID
of the running chart instance.java.lang.Exception
void cancelChart(java.util.UUID instanceId) throws java.lang.Exception
instanceId
.instanceId
- the UUID
of the chart instance to stop.java.lang.Exception
void pauseChart(java.util.UUID instanceId) throws java.lang.Exception
instanceId
.instanceId
- the UUID
of the chart instance to pause.java.lang.Exception
void resumeChart(java.util.UUID instanceId) throws java.lang.Exception
instanceId
.instanceId
- the UUID
of the chart instance to resume.java.lang.Exception
void debugStep(java.util.UUID instanceId) throws java.lang.Exception
java.lang.Exception
void debugResume(java.util.UUID instanceId) throws java.lang.Exception
java.lang.Exception
java.util.List<ChartInfo> getRunningCharts() throws java.lang.Exception
java.lang.Exception
java.util.List<ChartInfo> getRunningCharts(java.lang.String chartPath) throws java.lang.Exception
java.lang.Exception
void setVariables(java.util.UUID instanceId, org.python.core.PyObject variableMap)
instanceId
by copying all of the variables
from the provided variableMap
into the chart's scope.instanceId
- the of the chart instance to update.variableMap
- a dictionary containing key-value pairs of serializable things to update in chart scope.void setVariables(java.util.UUID instanceId, java.util.UUID stepId, org.python.core.PyObject variableMap)
PyChartScope getVariables(java.util.UUID instanceId) throws java.lang.Exception
java.lang.Exception
void redundantCheckpoint(java.util.UUID instanceId) throws java.lang.Exception
instanceId
- the UUID of the chart instance to update.java.lang.Exception
- if the redundant peer is not set up or connected, or if the chart does not have
redundancy sync enabled.