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

Class TransactGetItemsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse

software.amazon.awssdk.services.dynamodb.model.TransactGetItemsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TransactGetItemsResponse.Builder,TransactGetItemsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class TransactGetItemsResponse
extends DynamoDbResponse
implements ToCopyableBuilder<TransactGetItemsResponse.Builder,TransactGetItemsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TransactGetItemsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static TransactGetItemsResponse.Builder	builder()
List<ConsumedCapacity>	consumedCapacity()	If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConsumedCapacity()	For responses, this returns true if the service returned a value for the ConsumedCapacity property.
int	hashCode()
boolean	hasResponses()	For responses, this returns true if the service returned a value for the Responses property.
List<ItemResponse>	responses()	An ordered array of up to 100 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TransactGetItemsResponse.Builder>	serializableBuilderClass()
TransactGetItemsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasConsumedCapacity

public final boolean hasConsumedCapacity()

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

consumedCapacity

public final List<ConsumedCapacity> consumedCapacity()

If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table.

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

Returns:

If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table.

hasResponses

public final boolean hasResponses()

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

responses

public final List<ItemResponse> responses()

An ordered array of up to 100 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item.

If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.

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

Returns:

An ordered array of up to 100 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item.

If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.

toBuilder

public TransactGetItemsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TransactGetItemsResponse.Builder,TransactGetItemsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static TransactGetItemsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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