Class ExecuteStatementResponse
- 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.ExecuteStatementResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>
@Generated("software.amazon.awssdk:codegen") public final class ExecuteStatementResponse extends DynamoDbResponse implements ToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ExecuteStatementResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExecuteStatementResponse.Builder
builder()
ConsumedCapacity
consumedCapacity()
Returns the value of the ConsumedCapacity property for this object.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasItems()
For responses, this returns true if the service returned a value for the Items property.boolean
hasLastEvaluatedKey()
For responses, this returns true if the service returned a value for the LastEvaluatedKey property.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.Map<String,AttributeValue>
lastEvaluatedKey()
The primary key of the item where the operation stopped, inclusive of the previous result set.String
nextToken()
If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response.List<SdkField<?>>
sdkFields()
static Class<? extends ExecuteStatementResponse.Builder>
serializableBuilderClass()
ExecuteStatementResponse.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
-
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
public 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. 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
public final String 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
public final ConsumedCapacity 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
public final Map<String,AttributeValue> 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
LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is no more data to be retrieved. IfLastEvaluatedKey
is 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 whenLastEvaluatedKey
is 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
LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is no more data to be retrieved. IfLastEvaluatedKey
is 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 whenLastEvaluatedKey
is empty.
-
toBuilder
public ExecuteStatementResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ExecuteStatementResponse.Builder,ExecuteStatementResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static ExecuteStatementResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ExecuteStatementResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-