Class Get

    • Method Detail

      • hasKey

        public final boolean hasKey()
        For responses, this returns true if the service returned a value for the Key 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.
      • key

        public final Map<String,​AttributeValue> key()

        A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

        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 hasKey() method.

        Returns:
        A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.
      • tableName

        public final String tableName()

        The name of the table from which to retrieve the specified item.

        Returns:
        The name of the table from which to retrieve the specified item.
      • projectionExpression

        public final String projectionExpression()

        A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

        Returns:
        A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.
      • hasExpressionAttributeNames

        public final boolean hasExpressionAttributeNames()
        For responses, this returns true if the service returned a value for the ExpressionAttributeNames 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.
      • expressionAttributeNames

        public final Map<String,​String> expressionAttributeNames()

        One or more substitution tokens for attribute names in the ProjectionExpression parameter.

        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 hasExpressionAttributeNames() method.

        Returns:
        One or more substitution tokens for attribute names in the ProjectionExpression parameter.
      • serializableBuilderClass

        public static Class<? extends Get.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)