software.amazon.awssdk.services.dynamodb.model

Class BatchStatementError

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.BatchStatementError

All Implemented Interfaces:

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

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

An error associated with a statement in a PartiQL batch that was run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchStatementError.Builder

Method Summary

Modifier and Type	Method and Description
static BatchStatementError.Builder	builder()
BatchStatementErrorCodeEnum	code() The error code associated with the failed PartiQL batch statement.
String	codeAsString() The error code associated with the failed PartiQL batch statement.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItem() For responses, this returns true if the service returned a value for the Item property.
Map<String,AttributeValue>	item() The item which caused the condition check to fail.
String	message() The error message associated with the PartiQL batch response.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchStatementError.Builder>	serializableBuilderClass()
BatchStatementError.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

code

public final BatchStatementErrorCodeEnum code()

The error code associated with the failed PartiQL batch statement.

If the service returns an enum value that is not available in the current SDK version, code will return BatchStatementErrorCodeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

Returns:

The error code associated with the failed PartiQL batch statement.

See Also:

BatchStatementErrorCodeEnum

codeAsString

public final String codeAsString()

The error code associated with the failed PartiQL batch statement.

If the service returns an enum value that is not available in the current SDK version, code will return BatchStatementErrorCodeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

Returns:

The error code associated with the failed PartiQL batch statement.

See Also:

BatchStatementErrorCodeEnum

message

public final String message()

The error message associated with the PartiQL batch response.

Returns:

The error message associated with the PartiQL batch response.

hasItem

public final boolean hasItem()

For responses, this returns true if the service returned a value for the Item 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.

item

public final Map<String,AttributeValue> item()

The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.

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

Returns:

The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.

toBuilder

public BatchStatementError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchStatementError.Builder,BatchStatementError>

builder

public static BatchStatementError.Builder builder()

serializableBuilderClass

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