@Generated(value="software.amazon.awssdk:codegen") public final class BatchStatementRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BatchStatementRequest.Builder,BatchStatementRequest>
A PartiQL batch statement request.
Modifier and Type | Class and Description |
---|---|
static interface |
BatchStatementRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static BatchStatementRequest.Builder |
builder() |
Boolean |
consistentRead()
The read consistency of the PartiQL batch request.
|
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.
|
List<AttributeValue> |
parameters()
The parameters associated with a PartiQL statement in the batch request.
|
ReturnValuesOnConditionCheckFailure |
returnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a
condition check.
|
String |
returnValuesOnConditionCheckFailureAsString()
An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a
condition check.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends BatchStatementRequest.Builder> |
serializableBuilderClass() |
String |
statement()
A valid PartiQL statement.
|
BatchStatementRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String statement()
A valid PartiQL statement.
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 associated with a PartiQL statement in the batch request.
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 read consistency of the PartiQL batch request.
public final ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for a PartiQL batch request 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()
.
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 a PartiQL batch request 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()
.
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 BatchStatementRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<BatchStatementRequest.Builder,BatchStatementRequest>
public static BatchStatementRequest.Builder builder()
public static Class<? extends BatchStatementRequest.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.