Page (AWS SDK for Java

Page (AWS SDK for Java - 2.25.21)
Type Parameters:
T - The modelled type of the object that has been read.

An immutable object that holds a page of queried or scanned results from DynamoDb.

Contains a reference to the last evaluated key for the current page; see lastEvaluatedKey() for more information.

  • Nested Class Summary

    Nested Classes

    static final class 

  • Method Summary

    Returns the capacity units consumed by the last page query or scan.

    The count of the returned items from the last page query or scan, after any filters were applied.

    Deprecated.

    Deprecated.

    boolean

    int

    Returns a page of mapped objects that represent records from a database query or scan.

    Returns the 'lastEvaluatedKey' that DynamoDb returned from the last page query or scan.

    The scanned count of the returned items from the last page query or scan, before any filters were applied.

  • Method Details

    • create

      Deprecated.

      Static constructor for this object. Deprecated in favor of using the builder() pattern to construct this object.

      Type Parameters:
      T - The modelled type of the object that has been read.
      Parameters:
      items - A list of items to store for the page.
      lastEvaluatedKey - A 'lastEvaluatedKey' to store for the page.
      Returns:
      A newly constructed Page object.
    • create

      Deprecated.

      Static constructor for this object that sets a null 'lastEvaluatedKey' which indicates this is the final page of results. Deprecated in favor of using the builder() pattern to construct this object.

      Type Parameters:
      T - The modelled type of the object that has been read.
      Parameters:
      items - A list of items to store for the page.
      Returns:
      A newly constructed Page object.
    • items

      Returns a page of mapped objects that represent records from a database query or scan.

      Returns:
      A list of mapped objects.
    • lastEvaluatedKey

      Returns the 'lastEvaluatedKey' that DynamoDb returned from the last page query or scan. This key can be used to continue the query or scan if passed into a request.

      Returns:
      The 'lastEvaluatedKey' from the last query or scan operation or null if the no more pages are available.
    • count

      The count of the returned items from the last page query or scan, after any filters were applied.

    • scannedCount

      The scanned count of the returned items from the last page query or scan, before any filters were applied. This number will be equal or greater than the count.

    • consumedCapacity

      Returns the capacity units consumed by the last page query or scan. Will only be returned if it has been explicitly requested by the user when calling the operation.

      Returns:
      The 'consumedCapacity' from the last query or scan operation or null if it was not requested.
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()

      Overrides:
      hashCode in class Object
    • toString

      Overrides:
      toString in class Object
    • builder


You Might Also Like