dynamodb/aws.sdk.kotlin.services.dynamodb.model/GetItemRequest

GetItemRequest

class GetItemRequest

Represents the input of a GetItem operation.

Types

Builder

class Builder

Companion

object Companion

Properties

attributesToGet

val attributesToGet: List<String>?

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

consistentRead

val consistentRead: Boolean?

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

expressionAttributeNames

val expressionAttributeNames: Map<String, String>?

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

key

val key: Map<String, AttributeValue>?

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

projectionExpression

val projectionExpression: String?

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

returnConsumedCapacity

val returnConsumedCapacity: ReturnConsumedCapacity?

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

tableName

val tableName: String?

The name of the table containing the requested item.

Functions

copy

inline fun copy(block: GetItemRequest.Builder.() -> Unit = {}): GetItemRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String