software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoGetItem.Builder

java.lang.Object

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

Enclosing class:

DynamoGetItem

@Stability(value=Experimental)
public static final class DynamoGetItem.Builder
extends Object

A fluent builder for DynamoGetItem.

Method Summary

Modifier and Type	Method and Description
DynamoGetItem	build()
DynamoGetItem.Builder	consistentRead(Boolean consistentRead) Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
static DynamoGetItem.Builder	create() EXPERIMENTAL
DynamoGetItem.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.
DynamoGetItem.Builder	partitionKey(DynamoAttribute partitionKey) A attribute representing the partition key of the item to retrieve.
DynamoGetItem.Builder	projectionExpression(List<DynamoProjectionExpression> projectionExpression) An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.
DynamoGetItem.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity) Determines the level of detail about provisioned throughput consumption that is returned in the response.
DynamoGetItem.Builder	sortKey(DynamoAttribute sortKey) A attribute representing the sort key of the item to retrieve.
DynamoGetItem.Builder	tableName(String tableName) The name of the table containing the requested item.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static DynamoGetItem.Builder create()

EXPERIMENTAL

Returns:

a new instance of DynamoGetItem.Builder.

partitionKey

@Stability(value=Experimental)
public DynamoGetItem.Builder partitionKey(DynamoAttribute partitionKey)

A attribute representing the partition key of the item to retrieve.

EXPERIMENTAL

Parameters:

partitionKey - A attribute representing the partition key of the item to retrieve. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key

tableName

@Stability(value=Experimental)
public DynamoGetItem.Builder tableName(String tableName)

The name of the table containing the requested item.

EXPERIMENTAL

Parameters:

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

Returns:

this

consistentRead

@Stability(value=Experimental)
public DynamoGetItem.Builder consistentRead(Boolean consistentRead)

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;

otherwise, the operation uses eventually consistent reads.

Default: false

EXPERIMENTAL

Parameters:

consistentRead - Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;. This parameter is required.

Returns:

this

expressionAttributeNames

@Stability(value=Experimental)
public DynamoGetItem.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)

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

Default: - No expression attributes

EXPERIMENTAL

Parameters:

expressionAttributeNames - One or more substitution tokens for attribute names in an expression. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ExpressionAttributeNames

projectionExpression

@Stability(value=Experimental)
public DynamoGetItem.Builder projectionExpression(List<DynamoProjectionExpression> 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.

Default: - No projection expression

EXPERIMENTAL

Parameters:

projectionExpression - An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ProjectionExpression

returnConsumedCapacity

@Stability(value=Experimental)
public DynamoGetItem.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)

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

Default: DynamoConsumedCapacity.NONE

EXPERIMENTAL

Parameters:

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

Returns:

this

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ReturnConsumedCapacity

sortKey

@Stability(value=Experimental)
public DynamoGetItem.Builder sortKey(DynamoAttribute sortKey)

A attribute representing the sort key of the item to retrieve.

Default: - No sort key

EXPERIMENTAL

Parameters:

sortKey - A attribute representing the sort key of the item to retrieve. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key

build

@Stability(value=Experimental)
public DynamoGetItem build()