com.marklogic.hub.flow

Class FlowInputs

java.lang.Object

com.marklogic.hub.flow.FlowInputs

public class FlowInputs
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FlowInputs()
FlowInputs(java.lang.String flowName)
FlowInputs(java.lang.String flowName, java.lang.String... steps)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFlowName()
java.lang.String	getJobId()
java.util.Map<java.lang.String,java.lang.Object>	getOptions()
java.util.Map<java.lang.String,java.lang.Object>	getStepConfig()
java.util.List<java.lang.String>	getSteps()
void	setFlowName(java.lang.String flowName)
void	setInputFilePath(java.lang.String inputFilePath) A common step configuration to override at runtime is the inputFilePath for an ingestion step.
void	setJobId(java.lang.String jobId)
void	setOptions(java.util.Map<java.lang.String,java.lang.Object> options)
void	setStepConfig(java.util.Map<java.lang.String,java.lang.Object> stepConfig)
void	setSteps(java.util.List<java.lang.String> steps)
FlowInputs	withJobId(java.lang.String jobId)
FlowInputs	withOption(java.lang.String name, java.lang.Object value) Convenience method for adding one option at a time.
FlowInputs	withOptions(java.util.Map<java.lang.String,java.lang.Object> options)
FlowInputs	withStepConfig(java.util.Map<java.lang.String,java.lang.Object> stepConfig)
FlowInputs	withSteps(java.lang.String... steps)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowInputs

public FlowInputs()

FlowInputs

public FlowInputs(java.lang.String flowName)

FlowInputs

public FlowInputs(java.lang.String flowName,
                  java.lang.String... steps)

Method Detail

setInputFilePath

public void setInputFilePath(java.lang.String inputFilePath)

A common step configuration to override at runtime is the inputFilePath for an ingestion step. This convenience method allows for doing that without modifying any existing step configuration.

Parameters:

inputFilePath -

getFlowName

public java.lang.String getFlowName()

setFlowName

public void setFlowName(java.lang.String flowName)

getSteps

public java.util.List<java.lang.String> getSteps()

setSteps

public void setSteps(java.util.List<java.lang.String> steps)

withSteps

public FlowInputs withSteps(java.lang.String... steps)

getJobId

public java.lang.String getJobId()

setJobId

public void setJobId(java.lang.String jobId)

withJobId

public FlowInputs withJobId(java.lang.String jobId)

getOptions

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

setOptions

public void setOptions(java.util.Map<java.lang.String,java.lang.Object> options)

withOption

public FlowInputs withOption(java.lang.String name,
                             java.lang.Object value)

Convenience method for adding one option at a time.

Parameters:

name -

value -

Returns:

withOptions

public FlowInputs withOptions(java.util.Map<java.lang.String,java.lang.Object> options)

getStepConfig

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

setStepConfig

public void setStepConfig(java.util.Map<java.lang.String,java.lang.Object> stepConfig)

withStepConfig

public FlowInputs withStepConfig(java.util.Map<java.lang.String,java.lang.Object> stepConfig)