Interface StepProcessorBuilder
public interface StepProcessorBuilder
Builder for processor of a custom step.
The Step Processor contains the main processing logic of the custom step.
One of the 3 main builders required for a custom step:
- StepConfigurationBuilder
- StepProcessorBuilder
- CustomTypeMetadataBuilder
- Since:
- 2.0.0
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionforOutputNode
(String outputId, StepProcessorFunction processorFunction) Configures the output node to which the results of the custom step will be associated with.registerIndex
(String indexName, Function<StepProcessorIndex.Builder, StepProcessorIndex> builderFunction) Registers the index for the processing of a custom stepregisterResource
(Function<StepResourceBuilderFactory, StepResource<T>> builder) Configures the resources to be used by the custom step.
-
Method Details
-
registerIndex
StepProcessorBuilder registerIndex(String indexName, Function<StepProcessorIndex.Builder, StepProcessorIndex> builderFunction) Registers the index for the processing of a custom step- Parameters:
indexName
- An arbitrary name for the indexbuilderFunction
- Function which takes a StepProcessorIndex.Builder as input and returns StepProcessorIndex- Returns:
- Step processor builder
- Since:
- 2.4.0
-
registerResource
<T> StepProcessorBuilder registerResource(Function<StepResourceBuilderFactory, StepResource<T>> builder) Configures the resources to be used by the custom step.Resources refer to any shared resources that can be created and used throughout processing. The resource should be closed after processing.
- Type Parameters:
T
- type of the step resource- Parameters:
builder
- builder for step resources- Returns:
- Step processor builder
-
forOutputNode
StepProcessorBuilder.Builder forOutputNode(String outputId, StepProcessorFunction processorFunction) Configures the output node to which the results of the custom step will be associated with.- Parameters:
outputId
- ID of output nodeprocessorFunction
- function defining the step processor logic- Returns:
- Step processor builder
-