software.amazon.awssdk.services.dynamodb.model

Class BatchStatementRequest

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.BatchStatementRequest

All Implemented Interfaces:

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

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

A PartiQL batch statement request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchStatementRequest.Builder

Method Summary

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

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 valid PartiQL statement.

Returns:

A valid PartiQL statement.

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

Returns:

The parameters associated with a PartiQL statement in the batch request.

consistentRead

public final Boolean consistentRead()

The read consistency of the PartiQL batch request.

Returns:

The read consistency of the PartiQL batch request.

toBuilder

public BatchStatementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchStatementRequest.Builder,BatchStatementRequest>

builder

public static BatchStatementRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchStatementRequest.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