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

Class ScanResponse

    • 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 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.

      • items

        public final List<Map<String,​AttributeValue>> items()

        An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

        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:
        An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

      • count

        public final Integer count()

        The number of items in the response.

        If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

        If you did not use a filter in the request, then Count is the same as ScannedCount.

        Returns:
        The number of items in the response.

        If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

        If you did not use a filter in the request, then Count is the same as ScannedCount.

      • scannedCount

        public final Integer scannedCount()

        The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

        If you did not use a filter in the request, then ScannedCount is the same as Count.

        Returns:
        The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

        If you did not use a filter in the request, then ScannedCount is the same as Count.

      • 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 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.

      • 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.

        If LastEvaluatedKey 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 when LastEvaluatedKey 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.

        If LastEvaluatedKey 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 when LastEvaluatedKey is empty.

      • consumedCapacity

        public final ConsumedCapacity consumedCapacity()

        The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

        Returns:
        The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

      • 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