FlowImpl (marklogic-data-hub 5.8.0 API)

java.lang.Object
- com.marklogic.hub.flow.impl.FlowImpl

All Implemented Interfaces:: Flow

public class FlowImpl
extends java.lang.Object
implements Flow

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_BATCH_SIZE

static boolean DEFAULT_STOP_ONERROR

static int DEFAULT_THREAD_COUNT

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BATCH_SIZE`
`static boolean`	`DEFAULT_STOP_ONERROR`
`static int`	`DEFAULT_THREAD_COUNT`

Constructor Summary

Constructors
Constructor and Description

FlowImpl()

Constructors
Constructor and Description
`FlowImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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 stepKey)` 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BATCH_SIZE
```
public static final int DEFAULT_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_COUNT
```
public static final int DEFAULT_THREAD_COUNT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STOP_ONERROR
```
public static final boolean DEFAULT_STOP_ONERROR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FlowImpl
```
public FlowImpl()
```
- Method Detail
  - getOverrideStepConfig
```
public java.util.Map<java.lang.String,java.lang.Object> getOverrideStepConfig()
```
    Description copied from interface: Flow
    
    Gets the overridden options that were set at java runtime
    
    Specified by:
    
    getOverrideStepConfig in interface Flow
    
    Returns:
    
    returns a map object containing the json object submitted at runtime for commands to flow runner
  - setOverrideStepConfig
```
public void setOverrideStepConfig(java.util.Map<java.lang.String,java.lang.Object> overrideStepConfig)
```
    Description copied from interface: Flow
    
    Sets the overridden step configs to use at java runtime
    
    Specified by:
    
    setOverrideStepConfig in interface Flow
    
    Parameters:
    
    overrideStepConfig - a map object that represents the json step runner config that are to be used at runtime
  - setRuntimeOptions
```
public void setRuntimeOptions(java.util.Map<java.lang.String,java.lang.Object> runtimeOptions)
```
    Description copied from interface: Flow
    
    Sets the overridden options for the flow to use at java runtime
    
    Specified by:
    
    setRuntimeOptions in interface Flow
    
    Parameters:
    
    runtimeOptions - a map object that represents the json flow options that are to be used at runtime
  - getRuntimeOptions
```
public java.util.Map<java.lang.String,java.lang.Object> getRuntimeOptions()
```
    Description copied from interface: Flow
    
    Gets the overridden options that were set at java runtime
    
    Specified by:
    
    getRuntimeOptions in interface Flow
    
    Returns:
    
    returns a map object containing the json object submitted at runtime for commands
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Flow
    
    Returns the name of the flow
    
    Specified by:
    
    getName in interface Flow
    
    Returns:
    
    a flow name
  - setName
```
public void setName(java.lang.String flowName)
```
    Description copied from interface: Flow
    
    Sets the name of the flow
    
    Specified by:
    
    setName in interface Flow
    
    Parameters:
    
    flowName - - a flow name
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Flow
    
    Returns flow description
    
    Specified by:
    
    getDescription in interface Flow
    
    Returns:
    
    - a flow description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description copied from interface: Flow
    
    Sets flow description
    
    Specified by:
    
    setDescription in interface Flow
    
    Parameters:
    
    description - a flow description
  - getBatchSize
```
public int getBatchSize()
```
    Description copied from interface: Flow
    
    Returns flow batch size
    
    Specified by:
    
    getBatchSize in interface Flow
    
    Returns:
    
    - flow batch size
  - setBatchSize
```
public void setBatchSize(int batchSize)
```
    Description copied from interface: Flow
    
    Set flow batch size
    
    Specified by:
    
    setBatchSize in interface Flow
    
    Parameters:
    
    batchSize - flow batch size
  - getThreadCount
```
public int getThreadCount()
```
    Description copied from interface: Flow
    
    Returns flow thread count
    
    Specified by:
    
    getThreadCount in interface Flow
    
    Returns:
    
    thread count for flow
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Description copied from interface: Flow
    
    Sets flow thread count
    
    Specified by:
    
    setThreadCount in interface Flow
    
    Parameters:
    
    threadCount - thread count for flow
  - getOptions
```
public com.fasterxml.jackson.databind.JsonNode getOptions()
```
    Description copied from interface: Flow
    
    Returns flow options as JsonNode
    
    Specified by:
    
    getOptions in interface Flow
    
    Returns:
    
    - options node
  - setOptions
```
public void setOptions(com.fasterxml.jackson.databind.JsonNode options)
```
    Description copied from interface: Flow
    
    Sets flow options
    
    Specified by:
    
    setOptions in interface Flow
    
    Parameters:
    
    options - - a options node
  - getSteps
```
public java.util.Map<java.lang.String,Step> getSteps()
```
    Description copied from interface: Flow
    
    Returns a map of Steps
    
    Specified by:
    
    getSteps in interface Flow
    
    Returns:
    
    - a map having Step number as key and Step model as value
  - setSteps
```
public void setSteps(java.util.Map<java.lang.String,Step> steps)
```
    Description copied from interface: Flow
    
    Sets the steps to the flow model
    
    Specified by:
    
    setSteps in interface Flow
    
    Parameters:
    
    steps - - a map having Step number as key and Step model as value
  - getStep
```
public Step getStep(java.lang.String stepKey)
```
    Description copied from interface: Flow
    
    Gets the step specified by string key
    
    Specified by:
    
    getStep in interface Flow
    
    Parameters:
    
    stepKey - the string key of the step (usually 1, 2, 3 etc)
    
    Returns:
    
    the step object that is stored in the flow
  - setStopOnError
```
public void setStopOnError(boolean stopOnError)
```
    Description copied from interface: Flow
    
    If set stops the flow on error
    
    Specified by:
    
    setStopOnError in interface Flow
    
    Parameters:
    
    stopOnError - boolean flag to stop on error
  - isStopOnError
```
public boolean isStopOnError()
```
    Description copied from interface: Flow
    
    Returns the value for stop on error flag
    
    Specified by:
    
    isStopOnError in interface Flow
    
    Returns:
    
    boolean flag to stop on error
  - getVersion
```
public int getVersion()
```
    Description copied from interface: Flow
    
    Gets version
    
    Specified by:
    
    getVersion in interface Flow
    
    Returns:
    
    an integer representing the version
  - setVersion
```
public void setVersion(int version)
```
    Description copied from interface: Flow
    
    Sets version
    
    Specified by:
    
    setVersion in interface Flow
    
    Parameters:
    
    version - version for the flow
  - deserialize
```
public Flow deserialize(com.fasterxml.jackson.databind.JsonNode json)
```
    Description copied from interface: Flow
    
    Deserialize a json response and applies it to this flow
    
    Specified by:
    
    deserialize in interface Flow
    
    Parameters:
    
    json - - the JsonNode you want deserialize
    
    Returns:
    
    this mapping
  - getStepById
```
@Deprecated
public Step getStepById(java.lang.String stepKey)
```
    Deprecated.
    
    Description copied from interface: Flow
    
    Use getStep instead. "Id" is a misnomer here; this is expected to a map key.
    
    Specified by:
    
    getStepById in interface Flow
    
    Parameters:
    
    stepKey - id for the step
    
    Returns:
    
    a step

Class FlowImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BATCH_SIZE

DEFAULT_THREAD_COUNT

DEFAULT_STOP_ONERROR

Constructor Detail

FlowImpl

Method Detail

getOverrideStepConfig

setOverrideStepConfig

setRuntimeOptions

getRuntimeOptions

getName

setName

getDescription

setDescription

getBatchSize

setBatchSize

getThreadCount

setThreadCount

getOptions

setOptions

getSteps

setSteps

getStep

setStopOnError

isStopOnError

getVersion

setVersion

deserialize

getStepById