Package com.amazonaws.services.dynamodbv2.document.api

Interface GetItemApi

  • All Known Implementing Classes:
    Table
    public interface GetItemApi
    A Table-centric GetItem API.

    In general, all getter methods in this library incur no network. GetItemApi is the only exception due to the fact that the web service API is indistinguishable from a Java getter method.

    • Method Detail

      • getItemOutcome

        GetItemOutcome getItemOutcome​(PrimaryKey primaryKey)
        Retrieves an item and the associated information by primary key. Incurs network access.
        Returns:
        the (non-null) result of item retrieval.

      • getItemOutcome

        GetItemOutcome getItemOutcome​(KeyAttribute... primaryKeyComponents)
        Retrieves an item and the associated information by primary key when the primary key is a hash-only key. Incurs network access.
        Returns:
        the (non-null) result of item retrieval.

      • getItemOutcome

        GetItemOutcome getItemOutcome​(String hashKeyName,
                              Object hashKeyValue)
        Retrieves an item and the associated information by primary key when the primary key is a hash-only key. Incurs network access.
        Returns:
        the (non-null) result of item retrieval.

      • getItemOutcome

        GetItemOutcome getItemOutcome​(String hashKeyName,
                              Object hashKeyValue,
                              String rangeKeyName,
                              Object rangeKeyValue)
        Retrieves an item and the associated information by primary key when the primary key consists of both a hash-key and a range-key. Incurs network access.
        Returns:
        the (non-null) result of item retrieval.

      • getItemOutcome

        GetItemOutcome getItemOutcome​(PrimaryKey primaryKey,
                              String projectionExpression,
                              Map<String,​String> nameMap)
        Retrieves an item and the associated information using projection expression. Incurs network access.
        Parameters:
        projectionExpression - projection expression, example: "a.b , c[0].e"
        nameMap - actual values for the attribute-name place holders; can be null if there is no attribute-name placeholder.
        Returns:
        the (non-null) result of item retrieval.

      • getItemOutcome

        GetItemOutcome getItemOutcome​(String hashKeyName,
                              Object hashKeyValue,
                              String projectionExpression,
                              Map<String,​String> nameMap)
        Retrieves an item and the associated information via the specified hash key using projection expression. Incurs network access.
        Returns:
        the (non-null) result of item retrieval.

      • getItemOutcome

        GetItemOutcome getItemOutcome​(String hashKeyName,
                              Object hashKeyValue,
                              String rangeKeyName,
                              Object rangeKeyValue,
                              String projectionExpression,
                              Map<String,​String> nameMap)
        Retrieves an item and the associated information via the specified hash key and range key using projection expression. Incurs network access.
        Returns:
        the (non-null) result of item retrieval.

      • getItem

        Item getItem​(String hashKeyName,
             Object hashKeyValue,
             String projectionExpression,
             Map<String,​String> nameMap)
        Retrieves an item via the specified hash key using projection expression. Incurs network access.
        Returns:
        the retrieved item; or null if the item doesn't exist.

      • getItem

        Item getItem​(String hashKeyName,
             Object hashKeyValue,
             String rangeKeyName,
             Object rangeKeyValue,
             String projectionExpression,
             Map<String,​String> nameMap)
        Retrieves an item via the specified hash key and range key using projection expression. Incurs network access.
        Returns:
        the retrieved item; or null if the item doesn't exist.

      • getItemOutcome

        GetItemOutcome getItemOutcome​(GetItemSpec spec)
        Retrieves an item and the associated information by specifying all the details. Incurs network access.
        Returns:
        the (non-null) result of item retrieval.

      • getItem

        Item getItem​(PrimaryKey primaryKey)
        Retrieves an item by primary key; or null if the item doesn't exist. Incurs network access.
        Returns:
        the retrieved item; or null if the item doesn't exist.

      • getItem

        Item getItem​(KeyAttribute... primaryKeyComponents)
        Retrieves an item by primary key. Incurs network access.
        Returns:
        the retrieved item; or null if the item doesn't exist.

      • getItem

        Item getItem​(String hashKeyName,
             Object hashKey)
        Retrieves an item by primary key when the primary key is a hash-only key. Incurs network access.
        Returns:
        the retrieved item; or null if the item doesn't exist.

      • getItem

        Item getItem​(String hashKeyName,
             Object hashKeyValue,
             String rangeKeyName,
             Object rangeKeyValue)
        Retrieves an item by primary key when the primary key consists of both a hash-key and a range-key. Incurs network access.
        Returns:
        the retrieved item; or null if the item doesn't exist.

      • getItem

        Item getItem​(PrimaryKey primaryKey,
             String projectionExpression,
             Map<String,​String> nameMap)
        Retrieves an item using projection expression. Incurs network access.
        Parameters:
        projectionExpression - projection expression, example: "a.b , c[0].e"
        nameMap - actual values for the attribute-name place holders; can be null if there is no attribute-name placeholder.
        Returns:
        the retrieved item; or null if the item doesn't exist.

      • getItem

        Item getItem​(GetItemSpec spec)
        Retrieves an item by specifying all the details. Incurs network access.
        Returns:
        the retrieved item; or null if the item doesn't exist.