DocumentBatchGet Class

.NET Framework 4.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...
Class for retrieving a batch of Documents from a single DynamoDB table.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet

Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.dll
Version: 2.0.0.3

Syntax

C#
public class DocumentBatchGet : Object

The DocumentBatchGet type exposes the following members

Constructors

  Name Description
Public Method DocumentBatchGet(Table) Constructs a DocumentBatchGet instance for a specific table.

Properties

  Name Description
Public Property AttributesToGet List of attributes to retrieve.
Public Property ConsistentRead If set to true, a consistent read is issued. Otherwise eventually-consistent is used.
Public Property Results List of results retrieved from DynamoDB. Populated after Execute is called.

Methods

  Name Description
Public Method AddKey(Primitive) Add a single item to get, identified by its hash primary key.
Public Method AddKey(Primitive, Primitive) Add a single item to get, identified by its hash-and-range primary key.
Public Method AddKey(IDictionary`2)
Public Method Combine(DocumentBatchGet) Creates a MultiTableDocumentBatchGet object that is a combination of the current DocumentBatchGet and the specified DocumentBatchGet.
Public Method Execute() Executes a server call to batch-get the documents requested. Populates Results with the retrieved items.
Public Method ExecuteAsync(CancellationToken) Initiates the asynchronous execution of the Execute operation.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5