Class MultiTableDocumentBatchGet
- Namespace
- Amazon.DynamoDBv2.DocumentModel
- Assembly
- AWSSDK.DynamoDBv2.dll
Class for retrieving a batch of Documents from multiple DynamoDB tables.
public class MultiTableDocumentBatchGet
- Inheritance
-
MultiTableDocumentBatchGet
- Inherited Members
Constructors
MultiTableDocumentBatchGet(params DocumentBatchGet[])
Constructs a MultiTableDocumentBatchGet object from a number of DocumentBatchGet objects.
public MultiTableDocumentBatchGet(params DocumentBatchGet[] batches)
Parameters
batches
DocumentBatchGet[]Collection of DocumentBatchGet objects.
Properties
Batches
List of DocumentBatchGet objects to include in the multi-table batch request.
public List<DocumentBatchGet> Batches { get; }
Property Value
TotalKeys
Total number of primary keys in the multi-table batch request.
public int TotalKeys { get; }
Property Value
Methods
AddBatch(DocumentBatchGet)
Add a DocumentBatchGet object to the multi-table batch request.
public void AddBatch(DocumentBatchGet batch)
Parameters
batch
DocumentBatchGetDocumentBatchGet to add.
ExecuteAsync(CancellationToken)
Initiates the asynchronous execution of the Execute operation. Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.Execute
public Task ExecuteAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken
CancellationTokenToken which can be used to cancel the task.
Returns
- Task
A Task that can be used to poll or wait for results, or both.