Package software.amazon.awscdk.services.stepfunctions

Class DistributedMapProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.DistributedMapProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DistributedMapProps>

Enclosing interface:

DistributedMapProps

@Stability(Stable)
public static final class DistributedMapProps.Builder
extends Object
implements software.amazon.jsii.Builder<DistributedMapProps>

A builder for DistributedMapProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DistributedMapProps	build()	Builds the configured instance.
DistributedMapProps.Builder	comment(String comment)	Sets the value of MapBaseProps.getComment()
DistributedMapProps.Builder	inputPath(String inputPath)	Sets the value of MapBaseProps.getInputPath()
DistributedMapProps.Builder	itemBatcher(ItemBatcher itemBatcher)	Sets the value of DistributedMapProps.getItemBatcher()
DistributedMapProps.Builder	itemReader(IItemReader itemReader)	Sets the value of DistributedMapProps.getItemReader()
DistributedMapProps.Builder	itemSelector(Map<String,? extends Object> itemSelector)	Sets the value of MapBaseProps.getItemSelector()
DistributedMapProps.Builder	itemsPath(String itemsPath)	Sets the value of MapBaseProps.getItemsPath()
DistributedMapProps.Builder	label(String label)	Sets the value of DistributedMapProps.getLabel()
DistributedMapProps.Builder	mapExecutionType(StateMachineType mapExecutionType)	Sets the value of DistributedMapProps.getMapExecutionType()
DistributedMapProps.Builder	maxConcurrency(Number maxConcurrency)	Sets the value of MapBaseProps.getMaxConcurrency()
DistributedMapProps.Builder	maxConcurrencyPath(String maxConcurrencyPath)	Sets the value of MapBaseProps.getMaxConcurrencyPath()
DistributedMapProps.Builder	outputPath(String outputPath)	Sets the value of MapBaseProps.getOutputPath()
DistributedMapProps.Builder	resultPath(String resultPath)	Sets the value of MapBaseProps.getResultPath()
DistributedMapProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of MapBaseProps.getResultSelector()
DistributedMapProps.Builder	resultWriter(ResultWriter resultWriter)	Sets the value of DistributedMapProps.getResultWriter()
DistributedMapProps.Builder	stateName(String stateName)	Sets the value of MapBaseProps.getStateName()
DistributedMapProps.Builder	toleratedFailureCount(Number toleratedFailureCount)	Sets the value of DistributedMapProps.getToleratedFailureCount()
DistributedMapProps.Builder	toleratedFailureCountPath(String toleratedFailureCountPath)	Sets the value of DistributedMapProps.getToleratedFailureCountPath()
DistributedMapProps.Builder	toleratedFailurePercentage(Number toleratedFailurePercentage)	Sets the value of DistributedMapProps.getToleratedFailurePercentage()
DistributedMapProps.Builder	toleratedFailurePercentagePath(String toleratedFailurePercentagePath)	Sets the value of DistributedMapProps.getToleratedFailurePercentagePath()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

itemBatcher

@Stability(Stable)
public DistributedMapProps.Builder itemBatcher(ItemBatcher itemBatcher)

Sets the value of DistributedMapProps.getItemBatcher()

Parameters:

itemBatcher - Specifies to process a group of items in a single child workflow execution.

Returns:

this

itemReader

@Stability(Stable)
public DistributedMapProps.Builder itemReader(IItemReader itemReader)

Sets the value of DistributedMapProps.getItemReader()

Parameters:

itemReader - ItemReader. Configuration for where to read items dataset in S3 to iterate

Returns:

this

label

@Stability(Stable)
public DistributedMapProps.Builder label(String label)

Sets the value of DistributedMapProps.getLabel()

Parameters:

label - Label. Unique name for the Distributed Map state added to each Map Run

Returns:

this

mapExecutionType

@Stability(Stable)
public DistributedMapProps.Builder mapExecutionType(StateMachineType mapExecutionType)

Sets the value of DistributedMapProps.getMapExecutionType()

Parameters:

mapExecutionType - MapExecutionType. The execution type of the distributed map state

This property overwrites ProcessorConfig.executionType

Returns:

this

resultWriter

@Stability(Stable)
public DistributedMapProps.Builder resultWriter(ResultWriter resultWriter)

Sets the value of DistributedMapProps.getResultWriter()

Parameters:

resultWriter - Configuration for S3 location in which to save Map Run results.

Returns:

this

toleratedFailureCount

@Stability(Stable)
public DistributedMapProps.Builder toleratedFailureCount(Number toleratedFailureCount)

Sets the value of DistributedMapProps.getToleratedFailureCount()

Parameters:

toleratedFailureCount - ToleratedFailureCount. Number of failed items to tolerate in a Map Run, as static number

Returns:

this

toleratedFailureCountPath

@Stability(Stable)
public DistributedMapProps.Builder toleratedFailureCountPath(String toleratedFailureCountPath)

Sets the value of DistributedMapProps.getToleratedFailureCountPath()

Parameters:

toleratedFailureCountPath - ToleratedFailureCountPath. Number of failed items to tolerate in a Map Run, as JsonPath

Returns:

this

toleratedFailurePercentage

@Stability(Stable)
public DistributedMapProps.Builder toleratedFailurePercentage(Number toleratedFailurePercentage)

Sets the value of DistributedMapProps.getToleratedFailurePercentage()

Parameters:

toleratedFailurePercentage - ToleratedFailurePercentage. Percentage of failed items to tolerate in a Map Run, as static number

Returns:

this

toleratedFailurePercentagePath

@Stability(Stable)
public DistributedMapProps.Builder toleratedFailurePercentagePath(String toleratedFailurePercentagePath)

Sets the value of DistributedMapProps.getToleratedFailurePercentagePath()

Parameters:

toleratedFailurePercentagePath - ToleratedFailurePercentagePath. Percentage of failed items to tolerate in a Map Run, as JsonPath

Returns:

this

comment

@Stability(Stable)
public DistributedMapProps.Builder comment(String comment)

Sets the value of MapBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

inputPath

@Stability(Stable)
public DistributedMapProps.Builder inputPath(String inputPath)

Sets the value of MapBaseProps.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

itemSelector

@Stability(Stable)
public DistributedMapProps.Builder itemSelector(Map<String,? extends Object> itemSelector)

Sets the value of MapBaseProps.getItemSelector()

Parameters:

itemSelector - The JSON that you want to override your default iteration input (mutually exclusive with parameters).

Returns:

this

itemsPath

@Stability(Stable)
public DistributedMapProps.Builder itemsPath(String itemsPath)

Sets the value of MapBaseProps.getItemsPath()

Parameters:

itemsPath - JSONPath expression to select the array to iterate over.

Returns:

this

maxConcurrency

@Stability(Stable)
public DistributedMapProps.Builder maxConcurrency(Number maxConcurrency)

Sets the value of MapBaseProps.getMaxConcurrency()

Parameters:

maxConcurrency - MaxConcurrency. An upper bound on the number of iterations you want running at once.

Returns:

this

maxConcurrencyPath

@Stability(Stable)
public DistributedMapProps.Builder maxConcurrencyPath(String maxConcurrencyPath)

Sets the value of MapBaseProps.getMaxConcurrencyPath()

Parameters:

maxConcurrencyPath - MaxConcurrencyPath. A JsonPath that specifies the maximum concurrency dynamically from the state input.

Returns:

this

outputPath

@Stability(Stable)
public DistributedMapProps.Builder outputPath(String outputPath)

Sets the value of MapBaseProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

resultPath

@Stability(Stable)
public DistributedMapProps.Builder resultPath(String resultPath)

Sets the value of MapBaseProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

@Stability(Stable)
public DistributedMapProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of MapBaseProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

stateName

@Stability(Stable)
public DistributedMapProps.Builder stateName(String stateName)

Sets the value of MapBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

build

@Stability(Stable)
public DistributedMapProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DistributedMapProps>

Returns:

a new instance of DistributedMapProps

Throws:

NullPointerException - if any required attribute was not provided