@Generated(value="software.amazon.awssdk:codegen") public final class ExecuteStatementRequest extends DynamoDbRequest implements ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ExecuteStatementRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ExecuteStatementRequest.Builder |
builder() |
Boolean |
consistentRead()
The consistency of a read operation.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.
|
Integer |
limit()
The maximum number of items to evaluate (not necessarily the number of matching items).
|
String |
nextToken()
Set this value to get remaining results, if
NextToken was returned in the statement response. |
List<AttributeValue> |
parameters()
The parameters for the PartiQL statement, if any.
|
ReturnConsumedCapacity |
returnConsumedCapacity()
Returns the value of the ReturnConsumedCapacity property for this object.
|
String |
returnConsumedCapacityAsString()
Returns the value of the ReturnConsumedCapacity property for this object.
|
ReturnValuesOnConditionCheckFailure |
returnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for an
ExecuteStatement operation that failed
a condition check. |
String |
returnValuesOnConditionCheckFailureAsString()
An optional parameter that returns the item attributes for an
ExecuteStatement operation that failed
a condition check. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ExecuteStatementRequest.Builder> |
serializableBuilderClass() |
String |
statement()
The PartiQL statement representing the operation to run.
|
ExecuteStatementRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String statement()
The PartiQL statement representing the operation to run.
public final boolean hasParameters()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<AttributeValue> parameters()
The parameters for the PartiQL statement, if any.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasParameters()
method.
public final 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.
true
, then a strongly consistent read is
used; otherwise, an eventually consistent read is used.public final String nextToken()
Set this value to get remaining results, if NextToken
was returned in the statement response.
NextToken
was returned in the statement
response.public final ReturnConsumedCapacity returnConsumedCapacity()
If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from returnConsumedCapacityAsString()
.
ReturnConsumedCapacity
public final String returnConsumedCapacityAsString()
If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from returnConsumedCapacityAsString()
.
ReturnConsumedCapacity
public final 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.
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 final 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.
If the service returns an enum value that is not available in the current SDK version,
returnValuesOnConditionCheckFailure
will return
ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from returnValuesOnConditionCheckFailureAsString()
.
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.
ReturnValuesOnConditionCheckFailure
public final String returnValuesOnConditionCheckFailureAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
returnValuesOnConditionCheckFailure
will return
ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from returnValuesOnConditionCheckFailureAsString()
.
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.
ReturnValuesOnConditionCheckFailure
public ExecuteStatementRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>
toBuilder
in class DynamoDbRequest
public static ExecuteStatementRequest.Builder builder()
public static Class<? extends ExecuteStatementRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.