public interface Flow
Modifier and Type | Method and Description |
---|---|
Flow |
deserialize(com.fasterxml.jackson.databind.JsonNode json)
Deserialize a json response and applies it to this flow
|
int |
getBatchSize()
Returns flow batch size
|
java.lang.String |
getDescription()
Returns flow description
|
java.lang.String |
getName()
Returns the name of the flow
|
com.fasterxml.jackson.databind.JsonNode |
getOptions()
Returns flow options as JsonNode
|
java.util.Map<java.lang.String,java.lang.Object> |
getOverrideStepConfig()
Gets the overridden options that were set at java runtime
|
java.util.Map<java.lang.String,java.lang.Object> |
getRuntimeOptions()
Gets the overridden options that were set at java runtime
|
Step |
getStep(java.lang.String stepKey)
Gets the step specified by string key
|
Step |
getStepById(java.lang.String stepId)
Deprecated.
|
java.util.Map<java.lang.String,Step> |
getSteps()
Returns a map of Steps
|
int |
getThreadCount()
Returns flow thread count
|
int |
getVersion()
Gets version
|
boolean |
isStopOnError()
Returns the value for stop on error flag
|
void |
setBatchSize(int batchSize)
Set flow batch size
|
void |
setDescription(java.lang.String description)
Sets flow description
|
void |
setName(java.lang.String flowName)
Sets the name of the flow
|
void |
setOptions(com.fasterxml.jackson.databind.JsonNode options)
Sets flow options
|
void |
setOverrideStepConfig(java.util.Map<java.lang.String,java.lang.Object> overrideStepConfig)
Sets the overridden step configs to use at java runtime
|
void |
setRuntimeOptions(java.util.Map<java.lang.String,java.lang.Object> runtimeOptions)
Sets the overridden options for the flow to use at java runtime
|
void |
setSteps(java.util.Map<java.lang.String,Step> steps)
Sets the steps to the flow model
|
void |
setStopOnError(boolean stopOnError)
If set stops the flow on error
|
void |
setThreadCount(int threadCount)
Sets flow thread count
|
void |
setVersion(int version)
Sets version
|
java.lang.String getName()
void setName(java.lang.String flowName)
flowName
- - a flow namejava.lang.String getDescription()
void setDescription(java.lang.String description)
description
- a flow descriptionint getBatchSize()
void setBatchSize(int batchSize)
batchSize
- flow batch sizeint getThreadCount()
void setThreadCount(int threadCount)
threadCount
- thread count for flowcom.fasterxml.jackson.databind.JsonNode getOptions()
void setOptions(com.fasterxml.jackson.databind.JsonNode options)
options
- - a options nodejava.util.Map<java.lang.String,Step> getSteps()
void setSteps(java.util.Map<java.lang.String,Step> steps)
steps
- - a map having Step number as key and Step model as valueStep getStep(java.lang.String stepKey)
stepKey
- the string key of the step (usually 1, 2, 3 etc)java.util.Map<java.lang.String,java.lang.Object> getRuntimeOptions()
void setRuntimeOptions(java.util.Map<java.lang.String,java.lang.Object> runtimeOptions)
runtimeOptions
- a map object that represents the json flow options that are to be used at runtimejava.util.Map<java.lang.String,java.lang.Object> getOverrideStepConfig()
void setOverrideStepConfig(java.util.Map<java.lang.String,java.lang.Object> overrideStepConfig)
overrideStepConfig
- a map object that represents the json step runner config that are to be used at runtimevoid setStopOnError(boolean stopOnError)
stopOnError
- boolean flag to stop on errorboolean isStopOnError()
int getVersion()
void setVersion(int version)
version
- version for the flowFlow deserialize(com.fasterxml.jackson.databind.JsonNode json)
json
- - the JsonNode you want deserialize@Deprecated Step getStepById(java.lang.String stepId)
stepId
- id for the step