public interface JobMXBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE
TYPE is used to identify this bean as a job bean when building the bean's
ObjectName . |
Modifier and Type | Method and Description |
---|---|
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.
|
void |
stateChange(Job.Action action)
Initiates an execution state change.
|
static final java.lang.String TYPE
ObjectName
.
The value is "job"java.lang.String getId()
java.lang.String getName()
Job.State getCurrentState()
Job.State getNextState()
Job.Health getHealth()
java.lang.String getLastError()
java.lang.String graphSnapshot()
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.void stateChange(Job.Action action)
action
- which triggers the state change.java.lang.IllegalArgumentException
- if the job is not in an appropriate
state for the requested action, or the action is not supported.Copyright © 2016 The Apache Software Foundation. All Rights Reserved - bbe71fa-20161201-1641