C# Class Amazon.DynamoDBv2.Model.GetItemRequest

Container for the parameters to the GetItem operation. The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Inheritance: AmazonDynamoDBRequest
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
GetItemRequest ( ) : System

Empty constructor used to set properties independently even when a simple constructor is available

GetItemRequest ( string tableName, AttributeValue>.Dictionary key ) : System

Instantiates GetItemRequest with the parameterized properties

GetItemRequest ( string tableName, AttributeValue>.Dictionary key, bool consistentRead ) : System

Instantiates GetItemRequest with the parameterized properties

Private Methods

Method Description
IsSetAttributesToGet ( ) : bool
IsSetConsistentRead ( ) : bool
IsSetExpressionAttributeNames ( ) : bool
IsSetKey ( ) : bool
IsSetProjectionExpression ( ) : bool
IsSetReturnConsumedCapacity ( ) : bool
IsSetTableName ( ) : bool

Method Details

GetItemRequest() public method

Empty constructor used to set properties independently even when a simple constructor is available
public GetItemRequest ( ) : System
return System

GetItemRequest() public method

Instantiates GetItemRequest with the parameterized properties
public GetItemRequest ( string tableName, AttributeValue>.Dictionary key ) : System
tableName string The name of the table containing the requested item.
key AttributeValue>.Dictionary A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve. 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.
return System

GetItemRequest() public method

Instantiates GetItemRequest with the parameterized properties
public GetItemRequest ( string tableName, AttributeValue>.Dictionary key, bool consistentRead ) : System
tableName string The name of the table containing the requested item.
key AttributeValue>.Dictionary A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve. 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.
consistentRead bool Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
return System