All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

The AWS Java SDK for Amazon DynamoDB module holds the client classes that are used for communicating with Amazon DynamoDB Service

There is a newer version: 1.12.772
Show newest version
/*
 * Copyright 2018-2023 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.AmazonWebServiceRequest;

/**
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ExecuteStatementRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * 

* The PartiQL statement representing the operation to run. *

*/ private String statement; /** *

* The parameters for the PartiQL statement, if any. *

*/ private java.util.List parameters; /** *

* The consistency of a read operation. If set to true, then a strongly consistent read is used; * otherwise, an eventually consistent read is used. *

*/ private Boolean consistentRead; /** *

* Set this value to get remaining results, if NextToken was returned in the statement response. *

*/ private String nextToken; private String returnConsumedCapacity; /** *

* The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the * number of items up to the limit while processing the results, it stops the operation and returns the matching * values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so * you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this * limit, it stops the operation and returns the matching values up to the limit, and a key in * LastEvaluatedKey to apply in a subsequent operation to continue the operation. *

*/ private Integer limit; /** *

* An optional parameter that returns the item attributes for an ExecuteStatement 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; /** *

* The PartiQL statement representing the operation to run. *

* * @param statement * The PartiQL statement representing the operation to run. */ public void setStatement(String statement) { this.statement = statement; } /** *

* The PartiQL statement representing the operation to run. *

* * @return The PartiQL statement representing the operation to run. */ public String getStatement() { return this.statement; } /** *

* The PartiQL statement representing the operation to run. *

* * @param statement * The PartiQL statement representing the operation to run. * @return Returns a reference to this object so that method calls can be chained together. */ public ExecuteStatementRequest withStatement(String statement) { setStatement(statement); return this; } /** *

* The parameters for the PartiQL statement, if any. *

* * @return The parameters for the PartiQL statement, if any. */ public java.util.List getParameters() { return parameters; } /** *

* The parameters for the PartiQL statement, if any. *

* * @param parameters * The parameters for the PartiQL statement, if any. */ public void setParameters(java.util.Collection parameters) { if (parameters == null) { this.parameters = null; return; } this.parameters = new java.util.ArrayList(parameters); } /** *

* The parameters for the PartiQL statement, if any. *

*

* 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 parameters for the PartiQL statement, if any. * @return Returns a reference to this object so that method calls can be chained together. */ public ExecuteStatementRequest 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 parameters for the PartiQL statement, if any. *

* * @param parameters * The parameters for the PartiQL statement, if any. * @return Returns a reference to this object so that method calls can be chained together. */ public ExecuteStatementRequest withParameters(java.util.Collection parameters) { setParameters(parameters); return this; } /** *

* The consistency of a read operation. If set to true, then a strongly consistent read is used; * otherwise, an eventually consistent read is used. *

* * @param consistentRead * The consistency of a read operation. If set to true, then a strongly consistent read is used; * otherwise, an eventually consistent read is used. */ public void setConsistentRead(Boolean consistentRead) { this.consistentRead = consistentRead; } /** *

* The consistency of a read operation. If set to true, then a strongly consistent read is used; * otherwise, an eventually consistent read is used. *

* * @return The consistency of a read operation. If set to true, then a strongly consistent read is * used; otherwise, an eventually consistent read is used. */ public Boolean getConsistentRead() { return this.consistentRead; } /** *

* The consistency of a read operation. If set to true, then a strongly consistent read is used; * otherwise, an eventually consistent read is used. *

* * @param consistentRead * The consistency of a read operation. If set to true, then a strongly consistent read is used; * otherwise, an eventually consistent read is used. * @return Returns a reference to this object so that method calls can be chained together. */ public ExecuteStatementRequest withConsistentRead(Boolean consistentRead) { setConsistentRead(consistentRead); return this; } /** *

* The consistency of a read operation. If set to true, then a strongly consistent read is used; * otherwise, an eventually consistent read is used. *

* * @return The consistency of a read operation. If set to true, then a strongly consistent read is * used; otherwise, an eventually consistent read is used. */ public Boolean isConsistentRead() { return this.consistentRead; } /** *

* Set this value to get remaining results, if NextToken was returned in the statement response. *

* * @param nextToken * Set this value to get remaining results, if NextToken was returned in the statement response. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* Set this value to get remaining results, if NextToken was returned in the statement response. *

* * @return Set this value to get remaining results, if NextToken was returned in the statement * response. */ public String getNextToken() { return this.nextToken; } /** *

* Set this value to get remaining results, if NextToken was returned in the statement response. *

* * @param nextToken * Set this value to get remaining results, if NextToken was returned in the statement response. * @return Returns a reference to this object so that method calls can be chained together. */ public ExecuteStatementRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** * @param returnConsumedCapacity * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; } /** * @return * @see ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return this.returnConsumedCapacity; } /** * @param returnConsumedCapacity * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnConsumedCapacity */ public ExecuteStatementRequest withReturnConsumedCapacity(String returnConsumedCapacity) { setReturnConsumedCapacity(returnConsumedCapacity); return this; } /** * @param returnConsumedCapacity * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnConsumedCapacity */ public ExecuteStatementRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); return this; } /** *

* The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the * number of items up to the limit while processing the results, it stops the operation and returns the matching * values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so * you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this * limit, it stops the operation and returns the matching values up to the limit, and a key in * LastEvaluatedKey to apply in a subsequent operation to continue the operation. *

* * @param limit * The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB * processes the number of items up to the limit while processing the results, it stops the operation and * returns the matching values up to that point, along with a key in LastEvaluatedKey to apply * in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size * exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up * to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue * the operation. */ public void setLimit(Integer limit) { this.limit = limit; } /** *

* The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the * number of items up to the limit while processing the results, it stops the operation and returns the matching * values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so * you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this * limit, it stops the operation and returns the matching values up to the limit, and a key in * LastEvaluatedKey to apply in a subsequent operation to continue the operation. *

* * @return The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB * processes the number of items up to the limit while processing the results, it stops the operation and * returns the matching values up to that point, along with a key in LastEvaluatedKey to apply * in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size * exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values * up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to * continue the operation. */ public Integer getLimit() { return this.limit; } /** *

* The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the * number of items up to the limit while processing the results, it stops the operation and returns the matching * values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so * you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this * limit, it stops the operation and returns the matching values up to the limit, and a key in * LastEvaluatedKey to apply in a subsequent operation to continue the operation. *

* * @param limit * The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB * processes the number of items up to the limit while processing the results, it stops the operation and * returns the matching values up to that point, along with a key in LastEvaluatedKey to apply * in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size * exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up * to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue * the operation. * @return Returns a reference to this object so that method calls can be chained together. */ public ExecuteStatementRequest withLimit(Integer limit) { setLimit(limit); return this; } /** *

* An optional parameter that returns the item attributes for an ExecuteStatement 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 an ExecuteStatement 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 an ExecuteStatement 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 an ExecuteStatement 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 an ExecuteStatement 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 an ExecuteStatement 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 ExecuteStatementRequest withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) { setReturnValuesOnConditionCheckFailure(returnValuesOnConditionCheckFailure); return this; } /** *

* An optional parameter that returns the item attributes for an ExecuteStatement 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 an ExecuteStatement 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 ExecuteStatementRequest 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 (getConsistentRead() != null) sb.append("ConsistentRead: ").append(getConsistentRead()).append(","); if (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()).append(","); if (getReturnConsumedCapacity() != null) sb.append("ReturnConsumedCapacity: ").append(getReturnConsumedCapacity()).append(","); if (getLimit() != null) sb.append("Limit: ").append(getLimit()).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 ExecuteStatementRequest == false) return false; ExecuteStatementRequest other = (ExecuteStatementRequest) 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.getConsistentRead() == null ^ this.getConsistentRead() == null) return false; if (other.getConsistentRead() != null && other.getConsistentRead().equals(this.getConsistentRead()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getReturnConsumedCapacity() == null ^ this.getReturnConsumedCapacity() == null) return false; if (other.getReturnConsumedCapacity() != null && other.getReturnConsumedCapacity().equals(this.getReturnConsumedCapacity()) == false) return false; if (other.getLimit() == null ^ this.getLimit() == null) return false; if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == 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 + ((getConsistentRead() == null) ? 0 : getConsistentRead().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getReturnConsumedCapacity() == null) ? 0 : getReturnConsumedCapacity().hashCode()); hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode()); hashCode = prime * hashCode + ((getReturnValuesOnConditionCheckFailure() == null) ? 0 : getReturnValuesOnConditionCheckFailure().hashCode()); return hashCode; } @Override public ExecuteStatementRequest clone() { return (ExecuteStatementRequest) super.clone(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy