com.amazonaws.services.dynamodbv2.model

Class ExecuteStatementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.ExecuteStatementRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExecuteStatementRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ExecuteStatementRequest()

Method Summary

Modifier and Type	Method and Description
ExecuteStatementRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getConsistentRead() The consistency of a read operation.
Integer	getLimit() The maximum number of items to evaluate (not necessarily the number of matching items).
String	getNextToken() Set this value to get remaining results, if NextToken was returned in the statement response.
List<AttributeValue>	getParameters() The parameters for the PartiQL statement, if any.
String	getReturnConsumedCapacity()
String	getReturnValuesOnConditionCheckFailure() An optional parameter that returns the item attributes for an ExecuteStatement operation that failed a condition check.
String	getStatement() The PartiQL statement representing the operation to run.
int	hashCode()
Boolean	isConsistentRead() The consistency of a read operation.
void	setConsistentRead(Boolean consistentRead) The consistency of a read operation.
void	setLimit(Integer limit) The maximum number of items to evaluate (not necessarily the number of matching items).
void	setNextToken(String nextToken) Set this value to get remaining results, if NextToken was returned in the statement response.
void	setParameters(Collection<AttributeValue> parameters) The parameters for the PartiQL statement, if any.
void	setReturnConsumedCapacity(String returnConsumedCapacity)
void	setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) An optional parameter that returns the item attributes for an ExecuteStatement operation that failed a condition check.
void	setStatement(String statement) The PartiQL statement representing the operation to run.
String	toString() Returns a string representation of this object.
ExecuteStatementRequest	withConsistentRead(Boolean consistentRead) The consistency of a read operation.
ExecuteStatementRequest	withLimit(Integer limit) The maximum number of items to evaluate (not necessarily the number of matching items).
ExecuteStatementRequest	withNextToken(String nextToken) Set this value to get remaining results, if NextToken was returned in the statement response.
ExecuteStatementRequest	withParameters(AttributeValue... parameters) The parameters for the PartiQL statement, if any.
ExecuteStatementRequest	withParameters(Collection<AttributeValue> parameters) The parameters for the PartiQL statement, if any.
ExecuteStatementRequest	withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
ExecuteStatementRequest	withReturnConsumedCapacity(String returnConsumedCapacity)
ExecuteStatementRequest	withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) An optional parameter that returns the item attributes for an ExecuteStatement operation that failed a condition check.
ExecuteStatementRequest	withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) An optional parameter that returns the item attributes for an ExecuteStatement operation that failed a condition check.
ExecuteStatementRequest	withStatement(String statement) The PartiQL statement representing the operation to run.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecuteStatementRequest

public ExecuteStatementRequest()

Method Detail

setStatement

public void setStatement(String statement)

The PartiQL statement representing the operation to run.

Parameters:

statement - The PartiQL statement representing the operation to run.

getStatement

public String getStatement()

The PartiQL statement representing the operation to run.

Returns:

The PartiQL statement representing the operation to run.

withStatement

public ExecuteStatementRequest withStatement(String statement)

The PartiQL statement representing the operation to run.

Parameters:

statement - The PartiQL statement representing the operation to run.

Returns:

Returns a reference to this object so that method calls can be chained together.

getParameters

public List<AttributeValue> getParameters()

The parameters for the PartiQL statement, if any.

Returns:

The parameters for the PartiQL statement, if any.

setParameters

public void setParameters(Collection<AttributeValue> parameters)

The parameters for the PartiQL statement, if any.

Parameters:

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

withParameters

public ExecuteStatementRequest withParameters(AttributeValue... parameters)

The parameters for the PartiQL statement, if any.

NOTE: This method appends the values to the existing list (if any). Use setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withParameters

public ExecuteStatementRequest withParameters(Collection<AttributeValue> parameters)

The parameters for the PartiQL statement, if any.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setConsistentRead

public void setConsistentRead(Boolean 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.

Parameters:

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.

getConsistentRead

public Boolean getConsistentRead()

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

Returns:

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

withConsistentRead

public ExecuteStatementRequest withConsistentRead(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isConsistentRead

public Boolean isConsistentRead()

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

Returns:

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

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public ExecuteStatementRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setReturnConsumedCapacity

public void setReturnConsumedCapacity(String returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

See Also:

ReturnConsumedCapacity

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

Returns:

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public ExecuteStatementRequest withReturnConsumedCapacity(String returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public ExecuteStatementRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

setLimit

public void setLimit(Integer 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.

Parameters:

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.

getLimit

public Integer getLimit()

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.

Returns:

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.

withLimit

public ExecuteStatementRequest withLimit(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setReturnValuesOnConditionCheckFailure

public void setReturnValuesOnConditionCheckFailure(String 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.

Parameters:

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 Also:

ReturnValuesOnConditionCheckFailure

getReturnValuesOnConditionCheckFailure

public String getReturnValuesOnConditionCheckFailure()

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.

Returns:

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 Also:

ReturnValuesOnConditionCheckFailure

withReturnValuesOnConditionCheckFailure

public ExecuteStatementRequest withReturnValuesOnConditionCheckFailure(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReturnValuesOnConditionCheckFailure

withReturnValuesOnConditionCheckFailure

public ExecuteStatementRequest withReturnValuesOnConditionCheckFailure(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReturnValuesOnConditionCheckFailure

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ExecuteStatementRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()