//tempest2/app.cash.tempest2

Package-level declarations

Types

Name	Summary
AsyncInlineView	[jvm] interface AsyncInlineView<K : Any, I : Any> : AsyncView<K, I> , AsyncScannable<K, I> , AsyncQueryable<K, I>
AsyncLogicalDb	[jvm] interface AsyncLogicalDb : AsyncLogicalTable.Factory A collection of tables that implement the DynamoDB best practice of putting multiple item types into the same storage table. This makes it possible to perform aggregate operations and transactions on those item types.
AsyncLogicalTable	[jvm] interface AsyncLogicalTable<RI : Any> : AsyncView<RI, RI> , AsyncInlineView.Factory, AsyncSecondaryIndex.Factory A collection of views on a DynamoDB table that makes it easy to model heterogeneous items using strongly typed data classes.
AsyncQueryable	[jvm] interface AsyncQueryable<K : Any, I : Any>
AsyncScannable	[jvm] interface AsyncScannable<K : Any, I : Any>
AsyncSecondaryIndex	[jvm] interface AsyncSecondaryIndex<K : Any, I : Any> : AsyncScannable<K, I> , AsyncQueryable<K, I>
AsyncView	[jvm] interface AsyncView<K : Any, I : Any>
Attribute	[jvm] @Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD]) annotation class Attribute(val name: String = "", val names: Array<String> = [], val prefix: String = "", val allowEmpty: Boolean = false) Maps an item class property to one or more attributes in a DynamoDB table.
BatchWriteResult	[jvm] data class BatchWriteResult(val unprocessedClobbers: List<Key>, val unprocessedDeletes: List<Key>) It contains information about the unprocessed items and the exception causing the failure.
BatchWriteSet	[jvm] data class BatchWriteSet(val itemsToClobber: ItemSet, val keysToDelete: KeySet) A write that the client sends to the DynamoDb service.
BeginsWith	[jvm] data class BeginsWith<K>(val prefix: K) : KeyCondition<K> Applies equality condition on the hash key and the following condition on the range key
Between	[jvm] data class Between<K>(val startInclusive: K, val endInclusive: K) : KeyCondition<K> Applies equality condition on the hash key and the following condition on the range key
Codec	[jvm] interface Codec<A : Any, D : Any> Converts values between the mutable DynamoDbBean objects that defines the union of all key and value attributes, and specific Tempest values.
ForIndex	[jvm] @Target(allowedTargets = [AnnotationTarget.CLASS]) annotation class ForIndex(val name: String = "") Maps an key class to a global or local secondary index in a DynamoDB table.
InlineView	[jvm] interface InlineView<K : Any, I : Any> : View<K, I> , Scannable<K, I> , Queryable<K, I>
ItemSet	[jvm] class ItemSet : Set<Any> A collection of items across tables.
KeyCondition	[jvm] sealed class KeyCondition<K> Used to query a table or an index.
KeySet	[jvm] class KeySet : Set<Any> A collection of keys or items across tables.
LogicalDb	[jvm] interface LogicalDb : LogicalTable.Factory A collection of tables that implement the DynamoDB best practice of putting multiple item types into the same storage table. This makes it possible to perform aggregate operations and transactions on those item types.
LogicalTable	[jvm] interface LogicalTable<RI : Any> : View<RI, RI> , InlineView.Factory, SecondaryIndex.Factory A collection of views on a DynamoDB table that makes it easy to model heterogeneous items using strongly typed data classes.
Offset	[jvm] data class Offset<K>(val key: K)
Page	[jvm] data class Page<K, T>
Queryable	[jvm] interface Queryable<K : Any, I : Any>
QueryConfig	[jvm] data class QueryConfig
ScanConfig	[jvm] data class ScanConfig
Scannable	[jvm] interface Scannable<K : Any, I : Any>
SecondaryIndex	[jvm] interface SecondaryIndex<K : Any, I : Any> : Scannable<K, I> , Queryable<K, I>
TableName	[jvm] @Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION]) annotation class TableName(val value: String = "") Maps an DB class property to a DynamoDB table.
TableNameResolver	[jvm] interface TableNameResolver Resolves the table name for a given LogicalTable class.
TransactionWriteSet	[jvm] data class TransactionWriteSet(val itemsToSave: ItemSet, val keysToDelete: KeySet, val keysToCheck: KeySet, val writeExpressions: Map<Any, Expression>, val idempotencyToken: String?)
View	[jvm] interface View<K : Any, I : Any>
WorkerId	[jvm] data class WorkerId(val segment: Int, val totalSegments: Int) In the context of parallel scans, a worker is analogous to a thread or an operating system process. Each worker then issues its own Scan request with a unique WorkerId, which represents a tuple of segment and totalSegments.
WritingPager	[jvm] class WritingPager<T>@JvmOverloadsconstructor(db: LogicalDb, updates: List<T>, maxTransactionItems: Int = 25, handler: WritingPager.Handler<T>) A control flow abstraction for paging transactional writes.

Functions

Name	Summary
transactionWritingPager	[jvm] fun <DB : LogicalDb, T> DB.transactionWritingPager(items: List<T>, maxTransactionItems: Int = 25, handler: WritingPager.Handler<T>): WritingPager<T>