Class ExecuteStatementResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final ConsumedCapacityReturns the value of the ConsumedCapacity property for this object.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanhasItems()For responses, this returns true if the service returned a value for the Items property.final booleanFor responses, this returns true if the service returned a value for the LastEvaluatedKey property.final List<Map<String,AttributeValue>> items()If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values.final Map<String,AttributeValue> The primary key of the item where the operation stopped, inclusive of the previous result set.final StringIf the response of a read request exceeds the response payload limit DynamoDB will set this value in the response.static Class<? extends ExecuteStatementResponse.Builder>final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasItems
public final boolean hasItems()For responses, this returns true if the service returned a value for the Items property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
items
If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.
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
hasItems()method.- Returns:
- If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.
-
nextToken
If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.
- Returns:
- If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.
-
consumedCapacity
Returns the value of the ConsumedCapacity property for this object.- Returns:
- The value of the ConsumedCapacity property for this object.
-
hasLastEvaluatedKey
public final boolean hasLastEvaluatedKey()For responses, this returns true if the service returned a value for the LastEvaluatedKey property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If
LastEvaluatedKeyis empty, then the "last page" of results has been processed and there is no more data to be retrieved. IfLastEvaluatedKeyis not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is whenLastEvaluatedKeyis empty.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
hasLastEvaluatedKey()method.- Returns:
- The primary key of the item where the operation stopped, inclusive of the previous result set. Use this
value to start a new operation, excluding this value in the new request. If
LastEvaluatedKeyis empty, then the "last page" of results has been processed and there is no more data to be retrieved. IfLastEvaluatedKeyis not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is whenLastEvaluatedKeyis empty.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse> - Specified by:
toBuilderin classAwsResponse
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-