software.amazon.awssdk.services.dynamodb.model.TransactionInProgressException Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.dynamodb.model;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * 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, 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)
 * 
 * 
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class TransactionInProgressException extends DynamoDbException implements
        ToCopyableBuilder {
    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList());

    private static final long serialVersionUID = 1L;

    private TransactionInProgressException(BuilderImpl builder) {
        super(builder);
    }

    @Override
    public Builder toBuilder() {
        return new BuilderImpl(this);
    }

    public static Builder builder() {
        return new BuilderImpl();
    }

    public static Class serializableBuilderClass() {
        return BuilderImpl.class;
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    public interface Builder extends SdkPojo, CopyableBuilder, DynamoDbException.Builder {
        @Override
        Builder awsErrorDetails(AwsErrorDetails awsErrorDetails);

        @Override
        Builder message(String message);

        @Override
        Builder requestId(String requestId);

        @Override
        Builder statusCode(int statusCode);

        @Override
        Builder cause(Throwable cause);

        @Override
        Builder writableStackTrace(Boolean writableStackTrace);
    }

    static final class BuilderImpl extends DynamoDbException.BuilderImpl implements Builder {
        private BuilderImpl() {
        }

        private BuilderImpl(TransactionInProgressException model) {
            super(model);
        }

        @Override
        public BuilderImpl awsErrorDetails(AwsErrorDetails awsErrorDetails) {
            this.awsErrorDetails = awsErrorDetails;
            return this;
        }

        @Override
        public BuilderImpl message(String message) {
            this.message = message;
            return this;
        }

        @Override
        public BuilderImpl requestId(String requestId) {
            this.requestId = requestId;
            return this;
        }

        @Override
        public BuilderImpl statusCode(int statusCode) {
            this.statusCode = statusCode;
            return this;
        }

        @Override
        public BuilderImpl cause(Throwable cause) {
            this.cause = cause;
            return this;
        }

        @Override
        public BuilderImpl writableStackTrace(Boolean writableStackTrace) {
            this.writableStackTrace = writableStackTrace;
            return this;
        }

        @Override
        public TransactionInProgressException build() {
            return new TransactionInProgressException(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}