Class GetItemSpec
java.lang.Object
com.amazonaws.services.dynamodbv2.document.spec.AbstractSpecWithPrimaryKey<GetItemRequest>
com.amazonaws.services.dynamodbv2.document.spec.GetItemSpec
Full parameter specification for the GetItem API.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionInternal method.void
setProgressListener
(ProgressListener progressListener) void
setRequestMetricCollector
(RequestMetricCollector requestMetricCollector) withAttributesToGet
(String... attrNames) withConsistentRead
(boolean consistentRead) Convenient method to specify expressions (and the associated name map and value map) viaGetItemExpressionSpec
.withNameMap
(Map<String, String> nameMap) Applicable only when an expression has been specified.withPrimaryKey
(KeyAttribute... components) Sets the primary key with the specified key components.withPrimaryKey
(PrimaryKey primaryKey) Sets the primary key.withPrimaryKey
(String hashKeyName, Object hashKeyValue) Sets the primary key with the specified hash-only key name and value.withPrimaryKey
(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Sets the primary key with the specified hash key and range key.withProgressListener
(ProgressListener progressListener) withProjectionExpression
(String projectionExpression) When a projection expression is specified, the corresponding name-map can optionally be specified via {withNameMap(Map)
.withRequestMetricCollector
(RequestMetricCollector requestMetricCollector) Methods inherited from class com.amazonaws.services.dynamodbv2.document.spec.AbstractSpecWithPrimaryKey
getKeyComponents
-
Constructor Details
-
GetItemSpec
public GetItemSpec()
-
-
Method Details
-
withPrimaryKey
Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key with the specified key components.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<GetItemRequest>
-
withPrimaryKey
Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<GetItemRequest>
-
withPrimaryKey
Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key with the specified hash-only key name and value.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<GetItemRequest>
-
withPrimaryKey
public GetItemSpec withPrimaryKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key with the specified hash key and range key.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<GetItemRequest>
-
getReturnConsumedCapacity
-
withReturnConsumedCapacity
-
getAttributesToGet
-
withAttributesToGet
-
isConsistentRead
-
withConsistentRead
-
getProjectionExpression
-
withProjectionExpression
When a projection expression is specified, the corresponding name-map can optionally be specified via {withNameMap(Map)
. (Note attributes-to-get must not be specified if a projection expression has been specified.) -
getNameMap
-
withNameMap
Applicable only when an expression has been specified. Used to specify the actual values for the attribute-name placeholders, where the value in the map can either be string for simple attribute name, or a JSON path expression. -
withProgressListener
-
withRequestMetricCollector
-
withExpressionSpec
Convenient method to specify expressions (and the associated name map and value map) viaGetItemExpressionSpec
. -
getRequest
Internal method. Not meant to be called directly. May change without notice. -
getProgressListener
-
setProgressListener
-
getRequestMetricCollector
-
setRequestMetricCollector
-