Modifier and Type | Method and Description |
---|---|
java.lang.String |
getControlId() |
Job.State |
getCurrentState()
Retrieves the current state of the job.
|
Job.Health |
getHealth()
Returns the summarized health indicator of the job.
|
java.lang.String |
getId()
Returns the identifier of the job.
|
java.lang.String |
getLastError()
Returns the last error message caught by the current job execution.
|
java.lang.String |
getName()
Returns the name of the job.
|
Job.State |
getNextState()
Retrieves the next execution state when the job makes a state
transition.
|
java.lang.String |
graphSnapshot()
Takes a current snapshot of the running graph and returns it in JSON format.
|
static EtiaoJobBean |
registerControl(ControlService cs,
EtiaoJob job)
Factory method which creates an
EtiaoJobBean instance to
control the specified EtiaoJob and registers it with the
specified ControlService . |
void |
stateChange(Job.Action action)
Initiates an execution state change.
|
boolean |
wasRegistered() |
public static EtiaoJobBean registerControl(ControlService cs, EtiaoJob job)
EtiaoJobBean
instance to
control the specified EtiaoJob
and registers it with the
specified ControlService
.cs
- the control servicejob
- the controlled jobpublic java.lang.String getControlId()
public boolean wasRegistered()
public java.lang.String getId()
JobMXBean
public java.lang.String getName()
JobMXBean
public Job.State getCurrentState()
JobMXBean
getCurrentState
in interface JobMXBean
public Job.State getNextState()
JobMXBean
getNextState
in interface JobMXBean
public java.lang.String graphSnapshot()
JobMXBean
The graph snapshot JSON format
The top-level object contains two properties:
vertices
: Array of JSON objects representing the graph vertices.edges
: Array of JSON objects representing the graph edges (an edge joins two vertices).id
: Unique identifier within a graph's JSON representation.instance
: The oplet instance from the vertex.sourceId
: The identifier of the source vertex.sourceOutputPort
: The identifier of the source oplet output port connected to the edge.targetId
: The identifier of the target vertex.targetInputPort
: The identifier of the target oplet input port connected to the edge.graphSnapshot
in interface JobMXBean
public Job.Health getHealth()
JobMXBean
public java.lang.String getLastError()
JobMXBean
getLastError
in interface JobMXBean
public void stateChange(Job.Action action)
JobMXBean
stateChange
in interface JobMXBean
action
- which triggers the state change.Copyright © 2016 The Apache Software Foundation. All Rights Reserved - bbe71fa-20161201-1641