public interface FlowStep<Config> extends ProcessModel
FlowSteps are submitted in order of dependency. If two or more steps do not share the same dependencies and all
can be scheduled simultaneously, the getSubmitPriority()
value determines the order in which
all steps will be submitted for execution. The default submit priority is 5.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CASCADING_FLOW_STEP_ID |
Modifier and Type | Method and Description |
---|---|
void |
addListener(FlowStepListener flowStepListener)
Method addListener registers the given
FlowStepListener with this instance. |
boolean |
containsPipeNamed(java.lang.String pipeName)
Returns true if this FlowStep contains a pipe/branch with the given name.
|
Config |
getConfig()
Method getConfig returns the current initialized configuration.
|
java.util.Map<java.lang.Object,java.lang.Object> |
getConfigAsProperties()
Method getConfigAsProperties converts the internal configuration object into a
Map of
key value pairs. |
Flow<Config> |
getFlow() |
java.lang.String |
getFlowID() |
java.lang.String |
getFlowName()
Method getParentFlowName returns the parentFlowName of this FlowStep object.
|
FlowNodeGraph |
getFlowNodeGraph() |
java.util.Map<java.lang.String,java.lang.String> |
getFlowStepDescriptor()
Returns an immutable map of properties giving more details about the FlowStep object.
|
FlowStepStats |
getFlowStepStats() |
Group |
getGroup() |
java.lang.String |
getID()
Method getId returns the id of this FlowStep object.
|
java.lang.String |
getName()
Method getName returns the name of this FlowStep object.
|
int |
getNumFlowNodes() |
int |
getOrdinal() |
Tap |
getSink() |
java.util.Set<java.lang.String> |
getSinkName(Tap sink) |
Tap |
getSinkWith(java.lang.String identifier) |
java.util.Set<java.lang.String> |
getSourceName(Tap source) |
Tap |
getSourceWith(java.lang.String identifier) |
java.lang.String |
getStepDisplayName()
Method getStepDisplayName returns the stepDisplayName of this FlowStep object.
|
int |
getSubmitPriority()
Method getSubmitPriority returns the submitPriority of this FlowStep object.
|
Tap |
getTrap(java.lang.String name) |
java.util.Set<Tap> |
getTraps() |
boolean |
hasListeners()
Method hasListeners returns true if
FlowStepListener instances have been registered. |
boolean |
removeListener(FlowStepListener flowStepListener)
Method removeListener removes the given flowStepListener from this instance.
|
void |
setFlowStepStats(FlowStepStats flowStepStats) |
void |
setSubmitPriority(int submitPriority)
Method setSubmitPriority sets the submitPriority of this FlowStep object.
|
addProcessAnnotation, addProcessAnnotation, getElementGraph, getGroups, getProcessAnnotations, getSinkElements, getSinkTaps, getSourceElements, getSourceTaps, getTrapMap
static final java.lang.String CASCADING_FLOW_STEP_ID
java.lang.String getID()
getID
in interface ProcessModel
int getOrdinal()
getOrdinal
in interface ProcessModel
java.lang.String getName()
getName
in interface ProcessModel
java.util.Map<java.lang.String,java.lang.String> getFlowStepDescriptor()
FlowStep descriptions provide meta-data to monitoring systems describing the workload a given FlowStep represents.
For known description types, see FlowStepDescriptors
.
java.lang.String getFlowID()
java.lang.String getFlowName()
Config getConfig()
The returned configuration is mutable and may be changed prior to this step being started or submitted.
java.util.Map<java.lang.Object,java.lang.Object> getConfigAsProperties()
Map
of
key value pairs.java.lang.String getStepDisplayName()
int getSubmitPriority()
10 is lowest, 1 is the highest, 5 is the default.
getSubmitPriority
in interface ProcessModel
void setSubmitPriority(int submitPriority)
10 is lowest, 1 is the highest, 5 is the default.
submitPriority
- the submitPriority of this FlowStep object.FlowNodeGraph getFlowNodeGraph()
int getNumFlowNodes()
java.util.Set<java.lang.String> getSourceName(Tap source)
java.util.Set<java.lang.String> getSinkName(Tap sink)
Tap getSourceWith(java.lang.String identifier)
Tap getSinkWith(java.lang.String identifier)
boolean containsPipeNamed(java.lang.String pipeName)
pipeName
- the name of the Pipevoid setFlowStepStats(FlowStepStats flowStepStats)
FlowStepStats getFlowStepStats()
boolean hasListeners()
FlowStepListener
instances have been registered.void addListener(FlowStepListener flowStepListener)
FlowStepListener
with this instance.flowStepListener
- of type flowStepListenerboolean removeListener(FlowStepListener flowStepListener)
flowStepListener
- of type FlowStepListenerCopyright © 2007-2017 Cascading Maintainers. All Rights Reserved.