Package software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoGetItemProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.DynamoGetItemProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DynamoGetItemProps>

Enclosing interface:

DynamoGetItemProps

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

A builder for DynamoGetItemProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DynamoGetItemProps	build()	Builds the configured instance.
DynamoGetItemProps.Builder	comment(String comment)	Sets the value of TaskStateBaseProps.getComment()
DynamoGetItemProps.Builder	consistentRead(Boolean consistentRead)	Sets the value of DynamoGetItemProps.getConsistentRead()
DynamoGetItemProps.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames)	Sets the value of DynamoGetItemProps.getExpressionAttributeNames()
DynamoGetItemProps.Builder	heartbeat(Duration heartbeat)	Sets the value of TaskStateBaseProps.getHeartbeat()
DynamoGetItemProps.Builder	inputPath(String inputPath)	Sets the value of TaskStateBaseProps.getInputPath()
DynamoGetItemProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseProps.getIntegrationPattern()
DynamoGetItemProps.Builder	key(Map<String,? extends DynamoAttributeValue> key)	Sets the value of DynamoGetItemProps.getKey()
DynamoGetItemProps.Builder	outputPath(String outputPath)	Sets the value of TaskStateBaseProps.getOutputPath()
DynamoGetItemProps.Builder	projectionExpression(List<? extends DynamoProjectionExpression> projectionExpression)	Sets the value of DynamoGetItemProps.getProjectionExpression()
DynamoGetItemProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
DynamoGetItemProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
DynamoGetItemProps.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)	Sets the value of DynamoGetItemProps.getReturnConsumedCapacity()
DynamoGetItemProps.Builder	table(ITable table)	Sets the value of DynamoGetItemProps.getTable()
DynamoGetItemProps.Builder	timeout(Duration timeout)	Sets the value of TaskStateBaseProps.getTimeout()

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

key

@Stability(Stable)
public DynamoGetItemProps.Builder key(Map<String,? extends DynamoAttributeValue> key)

Sets the value of DynamoGetItemProps.getKey()

Parameters:

key - Primary key of the item to retrieve. This parameter is required. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Returns:

this

table

@Stability(Stable)
public DynamoGetItemProps.Builder table(ITable table)

Sets the value of DynamoGetItemProps.getTable()

Parameters:

table - The name of the table containing the requested item. This parameter is required.

Returns:

this

consistentRead

@Stability(Stable)
public DynamoGetItemProps.Builder consistentRead(Boolean consistentRead)

Sets the value of DynamoGetItemProps.getConsistentRead()

Parameters:

consistentRead - Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;. otherwise, the operation uses eventually consistent reads.

Returns:

this

expressionAttributeNames

@Stability(Stable)
public DynamoGetItemProps.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)

Sets the value of DynamoGetItemProps.getExpressionAttributeNames()

Parameters:

expressionAttributeNames - One or more substitution tokens for attribute names in an expression.

Returns:

this

projectionExpression

@Stability(Stable)
public DynamoGetItemProps.Builder projectionExpression(List<? extends DynamoProjectionExpression> projectionExpression)

Sets the value of DynamoGetItemProps.getProjectionExpression()

Parameters:

projectionExpression - An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document.

Returns:

this

returnConsumedCapacity

@Stability(Stable)
public DynamoGetItemProps.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)

Sets the value of DynamoGetItemProps.getReturnConsumedCapacity()

Parameters:

returnConsumedCapacity - Determines the level of detail about provisioned throughput consumption that is returned in the response.

Returns:

this

comment

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

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

heartbeat

@Stability(Stable)
public DynamoGetItemProps.Builder heartbeat(Duration heartbeat)

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

inputPath

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

Sets the value of TaskStateBaseProps.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

integrationPattern

@Stability(Stable)
public DynamoGetItemProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns

Returns:

this

outputPath

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

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next 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 DynamoGetItemProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.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 DynamoGetItemProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.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

timeout

@Stability(Stable)
public DynamoGetItemProps.Builder timeout(Duration timeout)

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the state machine.

Returns:

this

build

@Stability(Stable)
public DynamoGetItemProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DynamoGetItemProps

Throws:

NullPointerException - if any required attribute was not provided