Show / Hide Table of Contents

Interface IDynamoTableTransactWriteItems

Interface to specify the TransactWriteItems operation.

Namespace: LambdaSharp.DynamoDB.Native.Operations
Assembly: LambdaSharp.DynamoDB.Native.dll
Syntax
public interface IDynamoTableTransactWriteItems

Methods

BeginConditionCheck<TRecord>(DynamoPrimaryKey<TRecord>)

Begin specification of a ConditionCheck operation for TransactWriteItems.

Declaration
IDynamoTableTransactWriteItemsConditionCheck<TRecord> BeginConditionCheck<TRecord>(DynamoPrimaryKey<TRecord> primaryKey)
    where TRecord : class
Parameters
Type Name Description
DynamoPrimaryKey<TRecord> primaryKey

Primary key of the item to write.

Returns
Type Description
IDynamoTableTransactWriteItemsConditionCheck<TRecord>
Type Parameters
Name Description
TRecord

The record type.

BeginDeleteItem<TRecord>(DynamoPrimaryKey<TRecord>)

Begin specification of a DeleteItem operation for TransactWriteItems.

Declaration
IDynamoTableTransactWriteItemsDeleteItem<TRecord> BeginDeleteItem<TRecord>(DynamoPrimaryKey<TRecord> primaryKey)
    where TRecord : class
Parameters
Type Name Description
DynamoPrimaryKey<TRecord> primaryKey

Primary key of the item to write.

Returns
Type Description
IDynamoTableTransactWriteItemsDeleteItem<TRecord>
Type Parameters
Name Description
TRecord

The record type.

BeginPutItem<TRecord>(DynamoPrimaryKey<TRecord>, TRecord)

Begin specification of a PutItem operation for TransactWriteItems.

Declaration
IDynamoTableTransactWriteItemsPutItem<TRecord> BeginPutItem<TRecord>(DynamoPrimaryKey<TRecord> primaryKey, TRecord record)
    where TRecord : class
Parameters
Type Name Description
DynamoPrimaryKey<TRecord> primaryKey

Primary key of the item to write.

TRecord record

The record to write

Returns
Type Description
IDynamoTableTransactWriteItemsPutItem<TRecord>
Type Parameters
Name Description
TRecord

The record type.

BeginUpdateItem<TRecord>(DynamoPrimaryKey<TRecord>)

Begin specification of a UpdateItem operation for TransactWriteItems.

Declaration
IDynamoTableTransactWriteItemsUpdateItem<TRecord> BeginUpdateItem<TRecord>(DynamoPrimaryKey<TRecord> primaryKey)
    where TRecord : class
Parameters
Type Name Description
DynamoPrimaryKey<TRecord> primaryKey

Primary key of the item to write.

Returns
Type Description
IDynamoTableTransactWriteItemsUpdateItem<TRecord>
Type Parameters
Name Description
TRecord

The record type.

DeleteItem<TRecord>(DynamoPrimaryKey<TRecord>)

Add a DeleteItem operation to TransactWriteItems.

This method is the same: BeginPutItem(primaryKey, record).End().

Declaration
virtual IDynamoTableTransactWriteItems DeleteItem<TRecord>(DynamoPrimaryKey<TRecord> primaryKey)
    where TRecord : class
Parameters
Type Name Description
DynamoPrimaryKey<TRecord> primaryKey

Primary key of the item to delete.

Returns
Type Description
IDynamoTableTransactWriteItems
Type Parameters
Name Description
TRecord

The record type.

PutItem<TRecord>(DynamoPrimaryKey<TRecord>, TRecord)

Add a PutItem operation to TransactWriteItems.

This method is the same: BeginPutItem(primaryKey, record).End().

Declaration
virtual IDynamoTableTransactWriteItems PutItem<TRecord>(DynamoPrimaryKey<TRecord> primaryKey, TRecord record)
    where TRecord : class
Parameters
Type Name Description
DynamoPrimaryKey<TRecord> primaryKey

Primary key of the item to delete.

TRecord record

The record to write

Returns
Type Description
IDynamoTableTransactWriteItems
Type Parameters
Name Description
TRecord

The record type.

TryExecuteAsync(CancellationToken)

Execute the TransactWriteItems operation.

Declaration
Task<bool> TryExecuteAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

True, when successful.

In This Article
Back to top Generated by DocFX