commonMain.aws.sdk.kotlin.services.dynamodb.model.TransactionInProgressException.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.dynamodb.model

import aws.smithy.kotlin.runtime.ServiceErrorMetadata

/**
 * The transaction with the given request token is already in progress.
 *
 *  Recommended Settings
 *
 *  This is a general recommendation for handling the `TransactionInProgressException`. These settings help ensure that the client retries will trigger completion of the ongoing `TransactWriteItems` request.
 *
 * +  Set `clientExecutionTimeout` to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the `TransactWriteItems` operation.
 * +  Set `socketTimeout` to a value a little lower than the `requestTimeout` setting.
 * + `requestTimeout` should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and `TransactionInProgressException` errors.
 * +  Use exponential backoff when retrying and tune backoff if needed.
 *
 *  Assuming [default retry policy](https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97), example timeout settings based on the guidelines above are as follows:
 *
 * Example timeline:
 * + 0-1000 first attempt
 * + 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
 * + 1500-2500 second attempt
 * + 2500-3500 second sleep/delay (500 * 2, exponential backoff)
 * + 3500-4500 third attempt
 * + 4500-6500 third sleep/delay (500 * 2^2)
 * + 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
 */
public class TransactionInProgressException private constructor(builder: Builder) : DynamoDbException(builder.message) {

    init {
        sdkErrorMetadata.attributes[ServiceErrorMetadata.ErrorType] = ErrorType.Client
    }

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.dynamodb.model.TransactionInProgressException = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("TransactionInProgressException(")
        append("message=$message")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = message?.hashCode() ?: 0
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as TransactionInProgressException

        if (message != other.message) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.dynamodb.model.TransactionInProgressException = Builder(this).apply(block).build()

    public class Builder {
        public var message: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.dynamodb.model.TransactionInProgressException) : this() {
            this.message = x.message
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.dynamodb.model.TransactionInProgressException = TransactionInProgressException(this)

        internal fun correctErrors(): Builder {
            return this
        }
    }
}