Package software.amazon.awssdk.services.dynamodb.model

Class CancellationReason

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.CancellationReason

All Implemented Interfaces:

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

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

An ordered list of errors for each item in the request which caused the transaction to get cancelled. The values of the list are ordered according to the ordering of the TransactWriteItems request parameter. If no error occurred for the associated item an error with a Null code and Null message will be present.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CancellationReason.Builder

Method Summary

Modifier and Type	Method	Description
static CancellationReason.Builder	builder()
String	code()	Status code for the result of the cancelled transaction.
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()	Item in the request which caused the transaction to get cancelled.
String	message()	Cancellation reason message description.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CancellationReason.Builder>	serializableBuilderClass()
CancellationReason.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

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

Item in the request which caused the transaction to get cancelled.

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:

Item in the request which caused the transaction to get cancelled.

code

public final String code()

Status code for the result of the cancelled transaction.

Returns:

Status code for the result of the cancelled transaction.

message

public final String message()

Cancellation reason message description.

Returns:

Cancellation reason message description.

toBuilder

public CancellationReason.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CancellationReason.Builder,CancellationReason>

builder

public static CancellationReason.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo