com.amazonaws.services.dynamodbv2.model.BatchStatementError Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-dynamodb Show documentation
The AWS Java SDK for Amazon DynamoDB module holds the client classes that are used for communicating with Amazon DynamoDB Service
The newest version!
/*
 * Copyright 2019-2024 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 com.amazonaws.services.dynamodbv2.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * An error associated with a statement in a PartiQL batch that was run.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchStatementError implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The error code associated with the failed PartiQL batch statement.
     * 
     */
    private String code;
    /**
     * 
     * The error message associated with the PartiQL batch response.
     * 
     */
    private String message;
    /**
     * 
     * The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is
     * specified as ALL_OLD.
     * 
     */
    private java.util.Map item;

    /**
     * 
     * The error code associated with the failed PartiQL batch statement.
     * 
     * 
     * @param code
     *        The error code associated with the failed PartiQL batch statement.
     * @see BatchStatementErrorCodeEnum
     */

    public void setCode(String code) {
        this.code = code;
    }

    /**
     * 
     * The error code associated with the failed PartiQL batch statement.
     * 
     * 
     * @return The error code associated with the failed PartiQL batch statement.
     * @see BatchStatementErrorCodeEnum
     */

    public String getCode() {
        return this.code;
    }

    /**
     * 
     * The error code associated with the failed PartiQL batch statement.
     * 
     * 
     * @param code
     *        The error code associated with the failed PartiQL batch statement.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see BatchStatementErrorCodeEnum
     */

    public BatchStatementError withCode(String code) {
        setCode(code);
        return this;
    }

    /**
     * 
     * The error code associated with the failed PartiQL batch statement.
     * 
     * 
     * @param code
     *        The error code associated with the failed PartiQL batch statement.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see BatchStatementErrorCodeEnum
     */

    public BatchStatementError withCode(BatchStatementErrorCodeEnum code) {
        this.code = code.toString();
        return this;
    }

    /**
     * 
     * The error message associated with the PartiQL batch response.
     * 
     * 
     * @param message
     *        The error message associated with the PartiQL batch response.
     */

    public void setMessage(String message) {
        this.message = message;
    }

    /**
     * 
     * The error message associated with the PartiQL batch response.
     * 
     * 
     * @return The error message associated with the PartiQL batch response.
     */

    public String getMessage() {
        return this.message;
    }

    /**
     * 
     * The error message associated with the PartiQL batch response.
     * 
     * 
     * @param message
     *        The error message associated with the PartiQL batch response.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public BatchStatementError withMessage(String message) {
        setMessage(message);
        return this;
    }

    /**
     * 
     * The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is
     * specified as ALL_OLD.
     * 
     * 
     * @return The item which caused the condition check to fail. This will be set if
     *         ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.
     */

    public java.util.Map getItem() {
        return item;
    }

    /**
     * 
     * The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is
     * specified as ALL_OLD.
     * 
     * 
     * @param item
     *        The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure
     *        is specified as ALL_OLD.
     */

    public void setItem(java.util.Map item) {
        this.item = item;
    }

    /**
     * 
     * The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is
     * specified as ALL_OLD.
     * 
     * 
     * @param item
     *        The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure
     *        is specified as ALL_OLD.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public BatchStatementError withItem(java.util.Map item) {
        setItem(item);
        return this;
    }

    /**
     * Add a single Item entry
     *
     * @see BatchStatementError#withItem
     * @returns a reference to this object so that method calls can be chained together.
     */

    public BatchStatementError addItemEntry(String key, AttributeValue value) {
        if (null == this.item) {
            this.item = new java.util.HashMap();
        }
        if (this.item.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.item.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Item.
     *
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public BatchStatementError clearItemEntries() {
        this.item = null;
        return this;
    }

    /**
     * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
     * redacted from this string using a placeholder value.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getCode() != null)
            sb.append("Code: ").append(getCode()).append(",");
        if (getMessage() != null)
            sb.append("Message: ").append(getMessage()).append(",");
        if (getItem() != null)
            sb.append("Item: ").append(getItem());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof BatchStatementError == false)
            return false;
        BatchStatementError other = (BatchStatementError) obj;
        if (other.getCode() == null ^ this.getCode() == null)
            return false;
        if (other.getCode() != null && other.getCode().equals(this.getCode()) == false)
            return false;
        if (other.getMessage() == null ^ this.getMessage() == null)
            return false;
        if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false)
            return false;
        if (other.getItem() == null ^ this.getItem() == null)
            return false;
        if (other.getItem() != null && other.getItem().equals(this.getItem()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getCode() == null) ? 0 : getCode().hashCode());
        hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
        hashCode = prime * hashCode + ((getItem() == null) ? 0 : getItem().hashCode());
        return hashCode;
    }

    @Override
    public BatchStatementError clone() {
        try {
            return (BatchStatementError) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.dynamodbv2.model.transform.BatchStatementErrorMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}