com.marklogic.hub.flow

Interface Flow

All Known Implementing Classes:

FlowImpl

public interface Flow

Method Summary

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

Method Detail

getName

java.lang.String getName()

Returns the name of the flow

Returns:

a flow name

setName

void setName(java.lang.String flowName)

Sets the name of the flow

Parameters:

flowName - - a flow name

getDescription

java.lang.String getDescription()

Returns flow description

Returns:

- a flow description

setDescription

void setDescription(java.lang.String description)

Sets flow description

Parameters:

description - a flow description

getBatchSize

int getBatchSize()

Returns flow batch size

Returns:

- flow batch size

setBatchSize

void setBatchSize(int batchSize)

Set flow batch size

Parameters:

batchSize - flow batch size

getThreadCount

int getThreadCount()

Returns flow thread count

Returns:

thread count for flow

setThreadCount

void setThreadCount(int threadCount)

Sets flow thread count

Parameters:

threadCount - thread count for flow

getOptions

com.fasterxml.jackson.databind.JsonNode getOptions()

Returns flow options as JsonNode

Returns:

- options node

setOptions

void setOptions(com.fasterxml.jackson.databind.JsonNode options)

Sets flow options

Parameters:

options - - a options node

getSteps

java.util.Map<java.lang.String,Step> getSteps()

Returns a map of Steps

Returns:

- a map having Step number as key and Step model as value

setSteps

void setSteps(java.util.Map<java.lang.String,Step> steps)

Sets the steps to the flow model

Parameters:

steps - - a map having Step number as key and Step model as value

getStep

Step getStep(java.lang.String stepKey)

Gets the step specified by string key

Parameters:

stepKey - the string key of the step (usually 1, 2, 3 etc)

Returns:

the step object that is stored in the flow

getRuntimeOptions

java.util.Map<java.lang.String,java.lang.Object> getRuntimeOptions()

Gets the overridden options that were set at java runtime

Returns:

returns a map object containing the json object submitted at runtime for commands

setRuntimeOptions

void setRuntimeOptions(java.util.Map<java.lang.String,java.lang.Object> runtimeOptions)

Sets the overridden options for the flow to use at java runtime

Parameters:

runtimeOptions - a map object that represents the json flow options that are to be used at runtime

getOverrideStepConfig

java.util.Map<java.lang.String,java.lang.Object> getOverrideStepConfig()

Gets the overridden options that were set at java runtime

Returns:

returns a map object containing the json object submitted at runtime for commands to flow runner

setOverrideStepConfig

void setOverrideStepConfig(java.util.Map<java.lang.String,java.lang.Object> overrideStepConfig)

Sets the overridden step configs to use at java runtime

Parameters:

overrideStepConfig - a map object that represents the json step runner config that are to be used at runtime

setStopOnError

void setStopOnError(boolean stopOnError)

If set stops the flow on error

Parameters:

stopOnError - boolean flag to stop on error

isStopOnError

boolean isStopOnError()

Returns the value for stop on error flag

Returns:

boolean flag to stop on error

getVersion

int getVersion()

Gets version

Returns:

an integer representing the version

setVersion

void setVersion(int version)

Sets version

Parameters:

version - version for the flow

deserialize

Flow deserialize(com.fasterxml.jackson.databind.JsonNode json)

Deserialize a json response and applies it to this flow

Parameters:

json - - the JsonNode you want deserialize

Returns:

this mapping

getStepById

@Deprecated
Step getStepById(java.lang.String stepId)

Deprecated.

Use getStep instead. "Id" is a misnomer here; this is expected to a map key.

Parameters:

stepId - id for the step

Returns:

a step