Interface SfcScriptingFunctions
-
- All Known Subinterfaces:
SfcRpcFunctions
- All Known Implementing Classes:
ClientScriptingFunctions
public interface SfcScriptingFunctions
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
cancelChart(java.util.UUID instanceId)
Cancels the chart instance indicated byinstanceId
.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 byinstanceId
.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 byinstanceId
.void
setVariables(java.util.UUID instanceId, java.util.UUID stepId, org.python.core.PyObject variableMap)
void
setVariables(java.util.UUID instanceId, org.python.core.PyObject variableMap)
Updates the chart indicated byinstanceId
by copying all of the variables from the providedvariableMap
into the chart's scope.java.util.UUID
startChart(java.lang.String projectName, java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters)
Start a Chart in ProjectprojectName
from the definition atchartPath
.java.util.UUID
startChart(java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters)
Deprecated.usestartChart(String, String, Map)
instead.
-
-
-
Method Detail
-
startChart
@Deprecated java.util.UUID startChart(java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.Exception
Deprecated.usestartChart(String, String, Map)
instead.Start a chart in ProjectProject.GLOBAL_PROJECT_NAME
from the definition atchartPath
.- Parameters:
chartPath
- the path to the chart definition.parameters
- the parameters passed to the chart scope.- Returns:
- The
UUID
of the running chart instance. - Throws:
java.lang.Exception
-
startChart
java.util.UUID startChart(java.lang.String projectName, java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.Exception
Start a Chart in ProjectprojectName
from the definition atchartPath
.- Parameters:
projectName
- the name of the project the chart definition resides in.chartPath
- the path to the chart definition.parameters
- the parameters passed to the chart scope.- Returns:
- The
UUID
of the running chart instance. - Throws:
java.lang.Exception
-
cancelChart
void cancelChart(java.util.UUID instanceId) throws java.lang.Exception
Cancels the chart instance indicated byinstanceId
.- Parameters:
instanceId
- theUUID
of the chart instance to stop.- Throws:
java.lang.Exception
-
pauseChart
void pauseChart(java.util.UUID instanceId) throws java.lang.Exception
Pause the chart instance indicated byinstanceId
.- Parameters:
instanceId
- theUUID
of the chart instance to pause.- Throws:
java.lang.Exception
-
resumeChart
void resumeChart(java.util.UUID instanceId) throws java.lang.Exception
Resume the chart instance indicated byinstanceId
.- Parameters:
instanceId
- theUUID
of the chart instance to resume.- Throws:
java.lang.Exception
-
debugStep
void debugStep(java.util.UUID instanceId) throws java.lang.Exception
Sends a message to the chart instance stopped at a breakpoint to step to the next step.- Throws:
java.lang.Exception
-
debugResume
void debugResume(java.util.UUID instanceId) throws java.lang.Exception
Sends a message to the chart instance stopped at a breakpoint to resume normal operations.- Throws:
java.lang.Exception
-
getRunningCharts
java.util.List<ChartInfo> getRunningCharts() throws java.lang.Exception
Returns information about the currently running charts.- Returns:
- Chart information about all of the currently running charts.
- Throws:
java.lang.Exception
-
getRunningCharts
java.util.List<ChartInfo> getRunningCharts(java.lang.String chartPath) throws java.lang.Exception
Returns information about the currently running instances of a given chart path.- Throws:
java.lang.Exception
-
setVariables
void setVariables(java.util.UUID instanceId, org.python.core.PyObject variableMap)
Updates the chart indicated byinstanceId
by copying all of the variables from the providedvariableMap
into the chart's scope.- Parameters:
instanceId
- the of the chart instance to update.variableMap
- a dictionary containing key-value pairs of serializable things to update in chart scope.
-
setVariables
void setVariables(java.util.UUID instanceId, java.util.UUID stepId, org.python.core.PyObject variableMap)
-
getVariables
PyChartScope getVariables(java.util.UUID instanceId) throws java.lang.Exception
Returns the chart scope for the specified instance. Step scopes for active steps are found under the "activeSteps" key.- Throws:
java.lang.Exception
-
redundantCheckpoint
void redundantCheckpoint(java.util.UUID instanceId) throws java.lang.Exception
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.- Parameters:
instanceId
- the UUID of the chart instance to update.- Throws:
java.lang.Exception
- if the redundant peer is not set up or connected, or if the chart does not have redundancy sync enabled.
-
-