com.amazonaws.services.dynamodbv2.model.ParameterizedStatement Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* 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;
/**
*
* Represents a PartiQL statement that uses parameters.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ParameterizedStatement implements Serializable, Cloneable, StructuredPojo {
/**
*
* A PartiQL statement that uses parameters.
*
*/
private String statement;
/**
*
* The parameter values.
*
*/
private java.util.List parameters;
/**
*
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
*
* There is no additional cost associated with requesting a return value aside from the small network and processing
* overhead of receiving a larger response. No read capacity units are consumed.
*
*/
private String returnValuesOnConditionCheckFailure;
/**
*
* A PartiQL statement that uses parameters.
*
*
* @param statement
* A PartiQL statement that uses parameters.
*/
public void setStatement(String statement) {
this.statement = statement;
}
/**
*
* A PartiQL statement that uses parameters.
*
*
* @return A PartiQL statement that uses parameters.
*/
public String getStatement() {
return this.statement;
}
/**
*
* A PartiQL statement that uses parameters.
*
*
* @param statement
* A PartiQL statement that uses parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ParameterizedStatement withStatement(String statement) {
setStatement(statement);
return this;
}
/**
*
* The parameter values.
*
*
* @return The parameter values.
*/
public java.util.List getParameters() {
return parameters;
}
/**
*
* The parameter values.
*
*
* @param parameters
* The parameter values.
*/
public void setParameters(java.util.Collection parameters) {
if (parameters == null) {
this.parameters = null;
return;
}
this.parameters = new java.util.ArrayList(parameters);
}
/**
*
* The parameter values.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setParameters(java.util.Collection)} or {@link #withParameters(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param parameters
* The parameter values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ParameterizedStatement withParameters(AttributeValue... parameters) {
if (this.parameters == null) {
setParameters(new java.util.ArrayList(parameters.length));
}
for (AttributeValue ele : parameters) {
this.parameters.add(ele);
}
return this;
}
/**
*
* The parameter values.
*
*
* @param parameters
* The parameter values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ParameterizedStatement withParameters(java.util.Collection parameters) {
setParameters(parameters);
return this;
}
/**
*
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
*
* There is no additional cost associated with requesting a return value aside from the small network and processing
* overhead of receiving a larger response. No read capacity units are consumed.
*
*
* @param returnValuesOnConditionCheckFailure
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
* There is no additional cost associated with requesting a return value aside from the small network and
* processing overhead of receiving a larger response. No read capacity units are consumed.
* @see ReturnValuesOnConditionCheckFailure
*/
public void setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) {
this.returnValuesOnConditionCheckFailure = returnValuesOnConditionCheckFailure;
}
/**
*
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
*
* There is no additional cost associated with requesting a return value aside from the small network and processing
* overhead of receiving a larger response. No read capacity units are consumed.
*
*
* @return An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
* There is no additional cost associated with requesting a return value aside from the small network and
* processing overhead of receiving a larger response. No read capacity units are consumed.
* @see ReturnValuesOnConditionCheckFailure
*/
public String getReturnValuesOnConditionCheckFailure() {
return this.returnValuesOnConditionCheckFailure;
}
/**
*
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
*
* There is no additional cost associated with requesting a return value aside from the small network and processing
* overhead of receiving a larger response. No read capacity units are consumed.
*
*
* @param returnValuesOnConditionCheckFailure
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
* There is no additional cost associated with requesting a return value aside from the small network and
* processing overhead of receiving a larger response. No read capacity units are consumed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnValuesOnConditionCheckFailure
*/
public ParameterizedStatement withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) {
setReturnValuesOnConditionCheckFailure(returnValuesOnConditionCheckFailure);
return this;
}
/**
*
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
*
* There is no additional cost associated with requesting a return value aside from the small network and processing
* overhead of receiving a larger response. No read capacity units are consumed.
*
*
* @param returnValuesOnConditionCheckFailure
* An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement
* operation that failed a condition check.
*
* There is no additional cost associated with requesting a return value aside from the small network and
* processing overhead of receiving a larger response. No read capacity units are consumed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnValuesOnConditionCheckFailure
*/
public ParameterizedStatement withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) {
this.returnValuesOnConditionCheckFailure = returnValuesOnConditionCheckFailure.toString();
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 (getStatement() != null)
sb.append("Statement: ").append(getStatement()).append(",");
if (getParameters() != null)
sb.append("Parameters: ").append(getParameters()).append(",");
if (getReturnValuesOnConditionCheckFailure() != null)
sb.append("ReturnValuesOnConditionCheckFailure: ").append(getReturnValuesOnConditionCheckFailure());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ParameterizedStatement == false)
return false;
ParameterizedStatement other = (ParameterizedStatement) obj;
if (other.getStatement() == null ^ this.getStatement() == null)
return false;
if (other.getStatement() != null && other.getStatement().equals(this.getStatement()) == false)
return false;
if (other.getParameters() == null ^ this.getParameters() == null)
return false;
if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
return false;
if (other.getReturnValuesOnConditionCheckFailure() == null ^ this.getReturnValuesOnConditionCheckFailure() == null)
return false;
if (other.getReturnValuesOnConditionCheckFailure() != null
&& other.getReturnValuesOnConditionCheckFailure().equals(this.getReturnValuesOnConditionCheckFailure()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStatement() == null) ? 0 : getStatement().hashCode());
hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
hashCode = prime * hashCode + ((getReturnValuesOnConditionCheckFailure() == null) ? 0 : getReturnValuesOnConditionCheckFailure().hashCode());
return hashCode;
}
@Override
public ParameterizedStatement clone() {
try {
return (ParameterizedStatement) 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.ParameterizedStatementMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}