commonMain.aws.sdk.kotlin.hll.dynamodbmapper.pipeline.LReqContext.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dynamodb-mapper-jvm Show documentation

High level DynamoDbMapper client

There is a newer version: 1.3.99-beta

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package aws.sdk.kotlin.hll.dynamodbmapper.pipeline

import aws.sdk.kotlin.hll.dynamodbmapper.items.ItemSchema
import aws.sdk.kotlin.hll.dynamodbmapper.operations.GetItemRequest
import aws.sdk.kotlin.hll.dynamodbmapper.pipeline.internal.LReqContextImpl
import aws.smithy.kotlin.runtime.ExperimentalApi
import aws.sdk.kotlin.services.dynamodb.model.GetItemRequest as LowLevelGetItemRequest

/**
 * Contextual data for stages in the pipeline dealing with low-level requests (i.e., between serialization and low-level
 * invocation)
 * @param T The type of objects being converted to/from DynamoDB items
 * @param HReq The type of high-level request object (e.g., [GetItemRequest])
 * @param LReq The type of low-level request object (e.g., [LowLevelGetItemRequest])
 */
@ExperimentalApi
public interface LReqContext : HReqContext {
    /**
     * The low-level request object which is to be used in the low-level operation invocation
     */
    public val lowLevelRequest: LReq
}

/**
 * Creates a new [LReqContext]
 * @param T The type of objects being converted to/from DynamoDB items
 * @param HReq The type of high-level request object (e.g., [GetItemRequest])
 * @param LReq The type of low-level request object (e.g., [LowLevelGetItemRequest])
 * @param highLevelRequest The high-level request object which is to be serialized into a low-level request object
 * @param serializeSchema The [ItemSchema] to use for serializing objects into items
 * @param mapperContext Additional, generalized context which may be useful to interceptors
 * @param lowLevelRequest The low-level request object which is to be used in the low-level operation invocation
 * @param error The most recent error which occurred, if any. Defaults to null.
 */
@ExperimentalApi
public fun  LReqContext(
    highLevelRequest: HReq,
    serializeSchema: ItemSchema,
    mapperContext: MapperContext,
    lowLevelRequest: LReq,
    error: Throwable? = null,
): LReqContext = LReqContextImpl(
    highLevelRequest,
    serializeSchema,
    mapperContext,
    lowLevelRequest,
    error,
)