public interface RunService
Modifier and Type | Field and Description |
---|---|
static String |
EVENT_TOPIC_ROOT |
static String |
RUN_CLOSED |
static String |
RUN_CREATED |
static String |
RUN_DELETED |
static String |
RUN_OPENED |
static String |
RUN_PAUSED |
static String |
RUN_RESUMED |
static String |
RUN_STARTED |
static String |
RUN_STOPPED |
Modifier and Type | Method and Description |
---|---|
void |
cancel(String runID)
Cancels a running or paused run.
|
void |
close(String runID)
Closes a run.
|
String |
createRun(RunProfile runProfile)
Creates a new run and returns the ID for the run.
|
void |
delete(String runID)
Deletes a run.
|
Bundle |
getDataBundle(String runID)
Returns the
Bundle containing the data values of the run. |
Set<ExecutionEnvironment> |
getExecutionEnvironments()
Returns the available
ExecutionEnvironment s. |
Set<ExecutionEnvironment> |
getExecutionEnvironments(Profile profile)
Returns the
ExecutionEnvironment s that can execute the
specified Profile . |
Set<ExecutionEnvironment> |
getExecutionEnvironments(WorkflowBundle workflowBundle)
Returns the
ExecutionEnvironment s that can execute the
specified WorkflowBundle using its default
Profile . |
Profile |
getProfile(String runID) |
String |
getRunName(String runID) |
List<String> |
getRuns()
Returns the list of runs that this service is managing.
|
State |
getState(String runID)
Returns the current state of the run.
|
Workflow |
getWorkflow(String runID) |
WorkflowReport |
getWorkflowReport(String runID)
Returns the status report for the run.
|
String |
open(Path runFile)
Opens a run and returns the ID for the run.
|
void |
pause(String runID)
Pauses a running run.
|
void |
resume(String runID)
Resumes a paused run.
|
void |
save(String runID,
Path runFile)
Saves a run.
|
void |
start(String runID)
Starts a run.
|
static final String EVENT_TOPIC_ROOT
static final String RUN_CREATED
static final String RUN_DELETED
static final String RUN_STARTED
static final String RUN_STOPPED
static final String RUN_PAUSED
static final String RUN_RESUMED
static final String RUN_OPENED
static final String RUN_CLOSED
Set<ExecutionEnvironment> getExecutionEnvironments()
ExecutionEnvironment
s.ExecutionEnvironment
sSet<ExecutionEnvironment> getExecutionEnvironments(WorkflowBundle workflowBundle)
ExecutionEnvironment
s that can execute the
specified WorkflowBundle
using its default
Profile
.workflowBundle
- the WorkflowBundle
to find
ExecutionEnvironment
s forExecutionEnvironment
s that can execute the
specified WorkflowBundle
Set<ExecutionEnvironment> getExecutionEnvironments(Profile profile)
ExecutionEnvironment
s that can execute the
specified Profile
.profile
- the Profile
to find
ExecutionEnvironment
s forExecutionEnvironment
s that can execute the
specified Profile
String createRun(RunProfile runProfile) throws InvalidWorkflowException, RunProfileException
start(String)
method.runProfile
- the workflow to runInvalidWorkflowException
RunProfileException
List<String> getRuns()
If there are no runs this method returns an empty list.
String open(Path runFile) throws IOException
runFile
- the workflow run to openInvalidWorkflowException
RunProfileException
IOException
void close(String runID) throws InvalidRunIdException, InvalidExecutionIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validInvalidExecutionIdException
void save(String runID, Path runFile) throws InvalidRunIdException, IOException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validInvalidExecutionIdException
IOException
void delete(String runID) throws InvalidRunIdException, InvalidExecutionIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validInvalidExecutionIdException
void start(String runID) throws InvalidRunIdException, RunStateException, InvalidExecutionIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validRunStateException
- if the run state is not CREATEDInvalidExecutionIdException
void pause(String runID) throws InvalidRunIdException, RunStateException, InvalidExecutionIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validRunStateException
- if the run state is not RUNNINGInvalidExecutionIdException
void resume(String runID) throws InvalidRunIdException, RunStateException, InvalidExecutionIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validRunStateException
- if the run state is not PAUSEDInvalidExecutionIdException
void cancel(String runID) throws InvalidRunIdException, RunStateException, InvalidExecutionIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validRunStateException
- if the run state is not RUNNING or PAUSEDInvalidExecutionIdException
State getState(String runID) throws InvalidRunIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validBundle getDataBundle(String runID) throws InvalidRunIdException
Bundle
containing the data values of the run.runID
- the ID of the runDatabundle
containing the data values of the runInvalidRunIdException
- if the run ID is not validWorkflowReport getWorkflowReport(String runID) throws InvalidRunIdException
runID
- the ID of the runInvalidRunIdException
- if the run ID is not validWorkflow getWorkflow(String runID) throws InvalidRunIdException
InvalidRunIdException
Profile getProfile(String runID) throws InvalidRunIdException
InvalidRunIdException
String getRunName(String runID) throws InvalidRunIdException
InvalidRunIdException
Copyright © 2015–2016 The Apache Software Foundation. All rights reserved.