Table of Contents

Class BatchGet<T>

Namespace
Amazon.DynamoDBv2.DataModel
Assembly
AWSSDK.DynamoDBv2.dll

Represents a strongly-typed object for retrieving a batch of items from a single DynamoDB table

public class BatchGet<T> : BatchGet

Type Parameters

T
Inheritance
BatchGet<T>
Inherited Members

Properties

Results

List of results retrieved from DynamoDB. Populated after Execute is called.

public List<T> Results { get; }

Property Value

List<T>

TypedResults

Gets and sets the TypedResults property.

protected List<T> TypedResults { get; set; }

Property Value

List<T>

Methods

AddKey(object)

Add a single item to get, identified by its hash primary key.

public void AddKey(object hashKey)

Parameters

hashKey object

Hash key of the item to get

AddKey(object, object)

Add a single item to get, identified by its hash-and-range primary key.

public void AddKey(object hashKey, object rangeKey)

Parameters

hashKey object

Hash key of the item to get

rangeKey object

Range key of the item to get

AddKey(T)

Add a single item to get.

public void AddKey(T keyObject)

Parameters

keyObject T

Object key of the item to get

Combine(params BatchGet[])

Creates a MultiTableBatchGet object that is a combination of the current BatchGet and the specified BatchGets

public MultiTableBatchGet Combine(params BatchGet[] otherBatches)

Parameters

otherBatches BatchGet[]

Other BatchGet objects

Returns

MultiTableBatchGet

MultiTableBatchGet consisting of the multiple BatchGet objects: the current batch and the passed-in batches.

ExecuteHelper()

Executes the batch get

protected override void ExecuteHelper()

ExecuteHelperAsync(CancellationToken)

Executes the batch get asynchronously

protected override Task ExecuteHelperAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task