public static final class DynamoGetItem.Builder
extends java.lang.Object
DynamoGetItem
.Modifier and Type | Method and Description |
---|---|
DynamoGetItem |
build() |
DynamoGetItem.Builder |
comment(java.lang.String comment)
An optional description for this state.
|
DynamoGetItem.Builder |
consistentRead(java.lang.Boolean consistentRead)
Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
|
static DynamoGetItem.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
DynamoGetItem.Builder |
expressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
DynamoGetItem.Builder |
heartbeat(Duration heartbeat)
Timeout for the heartbeat.
|
DynamoGetItem.Builder |
inputPath(java.lang.String inputPath)
JSONPath expression to select part of the state to be the input to this state.
|
DynamoGetItem.Builder |
integrationPattern(IntegrationPattern integrationPattern)
AWS Step Functions integrates with services directly in the Amazon States Language.
|
DynamoGetItem.Builder |
key(java.util.Map<java.lang.String,? extends DynamoAttributeValue> key)
Primary key of the item to retrieve.
|
DynamoGetItem.Builder |
outputPath(java.lang.String outputPath)
JSONPath expression to select select a portion of the state output to pass to the next state.
|
DynamoGetItem.Builder |
projectionExpression(java.util.List<? extends DynamoProjectionExpression> projectionExpression)
An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.
|
DynamoGetItem.Builder |
resultPath(java.lang.String resultPath)
JSONPath expression to indicate where to inject the state's output.
|
DynamoGetItem.Builder |
resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
|
DynamoGetItem.Builder |
returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response.
|
DynamoGetItem.Builder |
table(ITable table)
The name of the table containing the requested item.
|
DynamoGetItem.Builder |
timeout(Duration timeout)
Timeout for the state machine.
|
public static DynamoGetItem.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.DynamoGetItem.Builder
.public DynamoGetItem.Builder comment(java.lang.String comment)
Default: - No comment
comment
- An optional description for this state. This parameter is required.this
public DynamoGetItem.Builder heartbeat(Duration heartbeat)
Default: - None
heartbeat
- Timeout for the heartbeat. This parameter is required.this
public DynamoGetItem.Builder inputPath(java.lang.String inputPath)
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.this
public DynamoGetItem.Builder integrationPattern(IntegrationPattern integrationPattern)
You can control these AWS services using service integration patterns
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.this
public DynamoGetItem.Builder outputPath(java.lang.String outputPath)
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
outputPath
- JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.this
public DynamoGetItem.Builder resultPath(java.lang.String resultPath)
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.this
public DynamoGetItem.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
resultSelector
- The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.this
public DynamoGetItem.Builder timeout(Duration timeout)
Default: - None
timeout
- Timeout for the state machine. This parameter is required.this
public DynamoGetItem.Builder key(java.util.Map<java.lang.String,? extends DynamoAttributeValue> key)
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.
key
- Primary key of the item to retrieve. This parameter is required.this
public DynamoGetItem.Builder table(ITable table)
table
- The name of the table containing the requested item. This parameter is required.this
public DynamoGetItem.Builder consistentRead(java.lang.Boolean consistentRead)
otherwise, the operation uses eventually consistent reads.
Default: false
consistentRead
- Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;. This parameter is required.this
public DynamoGetItem.Builder expressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
Default: - No expression attributes
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. This parameter is required.this
public DynamoGetItem.Builder projectionExpression(java.util.List<? extends DynamoProjectionExpression> projectionExpression)
These attributes can include scalars, sets, or elements of a JSON document.
Default: - No projection expression
projectionExpression
- An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table. This parameter is required.this
public DynamoGetItem.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)
Default: DynamoConsumedCapacity.NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response. This parameter is required.this
public DynamoGetItem build()