software.amazon.awssdk.services.dynamodb.model

Class ExecuteStatementRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest

software.amazon.awssdk.services.dynamodb.model.ExecuteStatementRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExecuteStatementRequest
extends DynamoDbRequest
implements ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecuteStatementRequest.Builder

Method Summary

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.
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.
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

statement

public final String statement()

The PartiQL statement representing the operation to run.

Returns:

The PartiQL statement representing the operation to run.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

parameters

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.

Returns:

The parameters for the PartiQL statement, if any.

consistentRead

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.

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.

nextToken

public final String nextToken()

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.

returnConsumedCapacity

public final ReturnConsumedCapacity returnConsumedCapacity()

Returns the value of the ReturnConsumedCapacity property for this object.

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().

Returns:

The value of the ReturnConsumedCapacity property for this object.

See Also:

ReturnConsumedCapacity

returnConsumedCapacityAsString

public final String returnConsumedCapacityAsString()

Returns the value of the ReturnConsumedCapacity property for this object.

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().

Returns:

The value of the ReturnConsumedCapacity property for this object.

See Also:

ReturnConsumedCapacity

toBuilder

public ExecuteStatementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

Specified by:

toBuilder in class DynamoDbRequest

builder

public static ExecuteStatementRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ExecuteStatementRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo