software.amazon.awssdk.services.dynamodb.model

Class ParameterizedStatement

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.ParameterizedStatement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ParameterizedStatement.Builder,ParameterizedStatement>

@Generated(value="software.amazon.awssdk:codegen")
public final class ParameterizedStatement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ParameterizedStatement.Builder,ParameterizedStatement>

Represents a PartiQL statment that uses parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParameterizedStatement.Builder

Method Summary

Modifier and Type	Method and Description
static ParameterizedStatement.Builder	builder()
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 parameter values.
ReturnValuesOnConditionCheckFailure	returnValuesOnConditionCheckFailure() An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement operation that failed a condition check.
String	returnValuesOnConditionCheckFailureAsString() An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement operation that failed a condition check.
List<SdkField<?>>	sdkFields()
static Class<? extends ParameterizedStatement.Builder>	serializableBuilderClass()
String	statement() A PartiQL statment that uses parameters.
ParameterizedStatement.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

A PartiQL statment that uses parameters.

Returns:

A PartiQL statment that uses parameters.

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

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

returnValuesOnConditionCheckFailure

public final ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()

An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement 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().

Returns:

An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement 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

returnValuesOnConditionCheckFailureAsString

public final String returnValuesOnConditionCheckFailureAsString()

An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement 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().

Returns:

An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement 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

toBuilder

public ParameterizedStatement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParameterizedStatement.Builder,ParameterizedStatement>

builder

public static ParameterizedStatement.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo