@ThreadSafe public interface GetItemApi
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.
Modifier and Type | Method and Description |
---|---|
Item |
getItem(GetItemSpec spec)
Retrieves an item by specifying all the details.
|
Item |
getItem(KeyAttribute... primaryKeyComponents)
Retrieves an item by primary key.
|
Item |
getItem(PrimaryKey primaryKey)
Retrieves an item by primary key; or null if the item doesn't exist.
|
Item |
getItem(PrimaryKey primaryKey,
String projectionExpression,
Map<String,String> nameMap)
Retrieves an item using projection expression.
|
Item |
getItem(String hashKeyName,
Object hashKey)
Retrieves an item by primary key when the primary key is a hash-only key.
|
Item |
getItem(String hashKeyName,
Object hashKeyValue,
String projectionExpression,
Map<String,String> nameMap)
Retrieves an item via the specified hash key using projection expression.
|
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.
|
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.
|
GetItemOutcome |
getItemOutcome(GetItemSpec spec)
Retrieves an item and the associated information by specifying all the
details.
|
GetItemOutcome |
getItemOutcome(KeyAttribute... primaryKeyComponents)
Retrieves an item and the associated information by primary key when the
primary key is a hash-only key.
|
GetItemOutcome |
getItemOutcome(PrimaryKey primaryKey)
Retrieves an item and the associated information by primary key.
|
GetItemOutcome |
getItemOutcome(PrimaryKey primaryKey,
String projectionExpression,
Map<String,String> nameMap)
Retrieves an item and the associated information using projection
expression.
|
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.
|
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.
|
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.
|
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.
|
GetItemOutcome getItemOutcome(PrimaryKey primaryKey)
GetItemOutcome getItemOutcome(KeyAttribute... primaryKeyComponents)
GetItemOutcome getItemOutcome(String hashKeyName, Object hashKeyValue)
GetItemOutcome getItemOutcome(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue)
GetItemOutcome getItemOutcome(PrimaryKey primaryKey, String projectionExpression, Map<String,String> nameMap)
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.GetItemOutcome getItemOutcome(String hashKeyName, Object hashKeyValue, String projectionExpression, Map<String,String> nameMap)
GetItemOutcome getItemOutcome(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue, String projectionExpression, Map<String,String> nameMap)
Item getItem(String hashKeyName, Object hashKeyValue, String projectionExpression, Map<String,String> nameMap)
Item getItem(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue, String projectionExpression, Map<String,String> nameMap)
GetItemOutcome getItemOutcome(GetItemSpec spec)
Item getItem(PrimaryKey primaryKey)
Item getItem(KeyAttribute... primaryKeyComponents)
Item getItem(String hashKeyName, Object hashKey)
Item getItem(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue)
Item getItem(PrimaryKey primaryKey, String projectionExpression, Map<String,String> nameMap)
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.Item getItem(GetItemSpec spec)