dynamodb-mapper/aws.sdk.kotlin.hll.dynamodbmapper.interceptors/TtlInterceptor

TtlInterceptor

class TtlInterceptor(clock: Clock = Clock.System) : Interceptor<Any, ItemSchema<Any>, Any, Any, Any, Any>

Interceptor that handles TTL fields defined on schema attributes and sets them to the current time plus their specified lifetimes. This affects the following operations:

PutItem is intercepted in modifyBeforeInvocation to update the low-level request item with the calculated field values
UpdateItem is intercepted in modifyBeforeSerialization to augment the high-level request's update expression
BatchWriteItem is intercepted in modifyBeforeInvocation to update the items of each low-level put request
TransactWriteItems is intercepted in both modifyBeforeSerialization (to augment the update expression of each Update action) and modifyBeforeInvocation (to update the items of each low-level Put action)

TTL fields are read from the schema associated with each operation. For the single-item operations this is the operation's serialize schema; for the multi-table operations (BatchWriteItem and TransactWriteItems) the operation-level schema is a placeholder, so the per-table schemas carried by the request are used instead.

Constructors

constructor(clock: Clock = Clock.System)

Functions

modifyBeforeInvocation

open override fun modifyBeforeInvocation(ctx: LReqContext<Any, ItemSchema<Any>, Any, Any>): Any

A modify hook that runs before the Low-level invocation step

modifyBeforeSerialization

open override fun modifyBeforeSerialization(ctx: HReqContext<Any, ItemSchema<Any>, Any>): SerializeInput<Any, ItemSchema<Any>, Any>

A modify hook that runs before the Serialization step

Inherited functions

modifyBeforeCompletion

open fun modifyBeforeCompletion(ctx: HResContext<Any, ItemSchema<Any>, Any, Any, Any, Any>): Any

A modify hook that runs before the Completion step

modifyBeforeDeserialization

open fun modifyBeforeDeserialization(ctx: LResContext<Any, ItemSchema<Any>, Any, Any, Any>): DeserializeInput<Any, ItemSchema<Any>, Any>

A modify hook that runs before the Deserialization step

readAfterDeserialization

open fun readAfterDeserialization(ctx: HResContext<Any, ItemSchema<Any>, Any, Any, Any, Any?>)

A read-only hook that runs after the Deserialization step

readAfterInitialization

open fun readAfterInitialization(ctx: HReqContext<Any, ItemSchema<Any>, Any>)

A read-only hook that runs after the Initialization step

readAfterInvocation

open fun readAfterInvocation(ctx: LResContext<Any, ItemSchema<Any>, Any, Any, Any?>)

A read-only hook that runs after the Low-level invocation step

readAfterSerialization

open fun readAfterSerialization(ctx: LReqContext<Any, ItemSchema<Any>, Any, Any?>)

A read-only hook that runs after the Serialization step

readBeforeCompletion

open fun readBeforeCompletion(ctx: HResContext<Any, ItemSchema<Any>, Any, Any, Any, Any>)

A read-only hook that runs before the Completion step

readBeforeDeserialization

open fun readBeforeDeserialization(ctx: LResContext<Any, ItemSchema<Any>, Any, Any, Any>)

A read-only hook that runs before the Deserialization step

readBeforeInvocation

open fun readBeforeInvocation(ctx: LReqContext<Any, ItemSchema<Any>, Any, Any>)

A read-only hook that runs before the Low-level invocation step

readBeforeSerialization

open fun readBeforeSerialization(ctx: HReqContext<Any, ItemSchema<Any>, Any>)

A read-only hook that runs before the Serialization step