Class ScanRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.dynamodbv2.model.ScanRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ScanRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a Scan operation.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ScanRequest()
Default constructor for ScanRequest object.ScanRequest(String tableName)
Constructs a new ScanRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ScanRequest
addExclusiveStartKeyEntry(String key, AttributeValue value)
ScanRequest
addExpressionAttributeNamesEntry(String key, String value)
ScanRequest
addExpressionAttributeValuesEntry(String key, AttributeValue value)
ScanRequest
addScanFilterEntry(String key, Condition value)
ScanRequest
clearExclusiveStartKeyEntries()
Removes all the entries added into ExclusiveStartKey.ScanRequest
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.ScanRequest
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.ScanRequest
clearScanFilterEntries()
Removes all the entries added into ScanFilter.ScanRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<String>
getAttributesToGet()
String
getConditionalOperator()
Boolean
getConsistentRead()
A Boolean value that determines the read consistency model during the scan:Map<String,AttributeValue>
getExclusiveStartKey()
The primary key of the first item that this operation will evaluate.Map<String,String>
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.Map<String,AttributeValue>
getExpressionAttributeValues()
One or more values that can be substituted in an expression.String
getFilterExpression()
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you.String
getIndexName()
The name of a secondary index to scan.Integer
getLimit()
The maximum number of items to evaluate (not necessarily the number of matching items).String
getProjectionExpression()
A string that identifies one or more attributes to retrieve from the specified table or index.String
getReturnConsumedCapacity()
Map<String,Condition>
getScanFilter()
Integer
getSegment()
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.String
getSelect()
The attributes to be returned in the result.String
getTableName()
The name of the table containing the requested items; or, if you provideIndexName
, the name of the table to which that index belongs.Integer
getTotalSegments()
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided.int
hashCode()
Boolean
isConsistentRead()
A Boolean value that determines the read consistency model during the scan:void
setAttributesToGet(Collection<String> attributesToGet)
void
setConditionalOperator(ConditionalOperator conditionalOperator)
void
setConditionalOperator(String conditionalOperator)
void
setConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:void
setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey)
The primary hash and range keys of the first item that this operation will evaluate.void
setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.void
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.void
setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.void
setFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you.void
setIndexName(String indexName)
The name of a secondary index to scan.void
setLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items).void
setProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index.void
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
void
setReturnConsumedCapacity(String returnConsumedCapacity)
void
setScanFilter(Map<String,Condition> scanFilter)
void
setSegment(Integer segment)
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.void
setSelect(Select select)
The attributes to be returned in the result.void
setSelect(String select)
The attributes to be returned in the result.void
setTableName(String tableName)
The name of the table containing the requested items; or, if you provideIndexName
, the name of the table to which that index belongs.void
setTotalSegments(Integer totalSegments)
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided.String
toString()
Returns a string representation of this object; useful for testing and debugging.ScanRequest
withAttributesToGet(String... attributesToGet)
ScanRequest
withAttributesToGet(Collection<String> attributesToGet)
ScanRequest
withConditionalOperator(ConditionalOperator conditionalOperator)
ScanRequest
withConditionalOperator(String conditionalOperator)
ScanRequest
withConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:ScanRequest
withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey)
The primary hash and range keys of the first item that this operation will evaluate.ScanRequest
withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.ScanRequest
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.ScanRequest
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.ScanRequest
withFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you.ScanRequest
withIndexName(String indexName)
The name of a secondary index to scan.ScanRequest
withLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items).ScanRequest
withProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index.ScanRequest
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
ScanRequest
withReturnConsumedCapacity(String returnConsumedCapacity)
ScanRequest
withScanFilter(Map<String,Condition> scanFilter)
ScanRequest
withSegment(Integer segment)
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.ScanRequest
withSelect(Select select)
The attributes to be returned in the result.ScanRequest
withSelect(String select)
The attributes to be returned in the result.ScanRequest
withTableName(String tableName)
The name of the table containing the requested items; or, if you provideIndexName
, the name of the table to which that index belongs.ScanRequest
withTotalSegments(Integer totalSegments)
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
ScanRequest
public ScanRequest()
Default constructor for ScanRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
ScanRequest
public ScanRequest(String tableName)
Constructs a new ScanRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
tableName
- The name of the table containing the requested items; or, if you provideIndexName
, the name of the table to which that index belongs.
-
-
Method Detail
-
setTableName
public void setTableName(String tableName)
The name of the table containing the requested items; or, if you provide
IndexName
, the name of the table to which that index belongs.- Parameters:
tableName
- The name of the table containing the requested items; or, if you provideIndexName
, the name of the table to which that index belongs.
-
getTableName
public String getTableName()
The name of the table containing the requested items; or, if you provide
IndexName
, the name of the table to which that index belongs.- Returns:
- The name of the table containing the requested items; or, if you
provide
IndexName
, the name of the table to which that index belongs.
-
withTableName
public ScanRequest withTableName(String tableName)
The name of the table containing the requested items; or, if you provide
IndexName
, the name of the table to which that index belongs.- Parameters:
tableName
- The name of the table containing the requested items; or, if you provideIndexName
, the name of the table to which that index belongs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIndexName
public void setIndexName(String indexName)
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the
IndexName
parameter, you must also provideTableName
.- Parameters:
indexName
- The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use theIndexName
parameter, you must also provideTableName
.
-
getIndexName
public String getIndexName()
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the
IndexName
parameter, you must also provideTableName
.- Returns:
- The name of a secondary index to scan. This index can be any
local secondary index or global secondary index. Note that if you
use the
IndexName
parameter, you must also provideTableName
.
-
withIndexName
public ScanRequest withIndexName(String indexName)
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the
IndexName
parameter, you must also provideTableName
.- Parameters:
indexName
- The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use theIndexName
parameter, you must also provideTableName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAttributesToGet
public List<String> getAttributesToGet()
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
- Returns:
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
-
setAttributesToGet
public void setAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
- Parameters:
attributesToGet
-This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
-
withAttributesToGet
public ScanRequest withAttributesToGet(String... attributesToGet)
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
NOTE: This method appends the values to the existing list (if any). Use
setAttributesToGet(java.util.Collection)
orwithAttributesToGet(java.util.Collection)
if you want to override the existing values.- Parameters:
attributesToGet
-This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAttributesToGet
public ScanRequest withAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
- Parameters:
attributesToGet
-This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
public void setLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
- Parameters:
limit
- The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
-
getLimit
public Integer getLimit()
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
- Returns:
- The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
-
withLimit
public ScanRequest withLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
- Parameters:
limit
- The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSelect
public void setSelect(String select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)- Parameters:
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)-
- See Also:
Select
-
-
getSelect
public String getSelect()
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)- Returns:
- The attributes to be returned in the result. You can retrieve all
item attributes, specific item attributes, or the count of
matching items.
-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.) -
- See Also:
Select
-
-
withSelect
public ScanRequest withSelect(String select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)- Parameters:
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Select
-
-
setSelect
public void setSelect(Select select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)- Parameters:
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)-
- See Also:
Select
-
-
withSelect
public ScanRequest withSelect(Select select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)- Parameters:
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.-
ALL_ATTRIBUTES
- Returns all of the item attributes. -
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
. -
COUNT
- Returns the number of matching items, rather than the matching items themselves. -
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select isSPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying AttributesToGet without any value for Select.)-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Select
-
-
getScanFilter
public Map<String,Condition> getScanFilter()
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example,
a
is greater thanA
, anda
is greater thanB
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
-
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
- Returns:
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example,
a
is greater thanA
, anda
is greater thanB
. For a list of code values, see http ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
-
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
-
-
-
setScanFilter
public void setScanFilter(Map<String,Condition> scanFilter)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example,
a
is greater thanA
, anda
is greater thanB
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
-
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
- Parameters:
scanFilter
-This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example,
a
is greater thanA
, anda
is greater thanB
. For a list of code values, see http ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
-
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
-
-
-
withScanFilter
public ScanRequest withScanFilter(Map<String,Condition> scanFilter)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example,
a
is greater thanA
, anda
is greater thanB
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
-
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
- Parameters:
scanFilter
-This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
-
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example,
a
is greater thanA
, anda
is greater thanB
. For a list of code values, see http ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
-
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addScanFilterEntry
public ScanRequest addScanFilterEntry(String key, Condition value)
-
clearScanFilterEntries
public ScanRequest clearScanFilterEntries()
Removes all the entries added into ScanFilter. <p> Returns a reference to this object so that method calls can be chained together.
-
setConditionalOperator
public void setConditionalOperator(String conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
-
- See Also:
ConditionalOperator
-
-
getConditionalOperator
public String getConditionalOperator()
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
- Returns:
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
-
- See Also:
ConditionalOperator
-
-
withConditionalOperator
public ScanRequest withConditionalOperator(String conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConditionalOperator
-
-
setConditionalOperator
public void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
-
- See Also:
ConditionalOperator
-
-
withConditionalOperator
public ScanRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
-
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true. -
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then
AND
is the default.The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConditionalOperator
-
-
getExclusiveStartKey
public Map<String,AttributeValue> getExclusiveStartKey()
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
- Returns:
- The primary key of the first item that this operation will
evaluate. Use the value that was returned for
LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
-
setExclusiveStartKey
public void setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
- Parameters:
exclusiveStartKey
- The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
-
withExclusiveStartKey
public ScanRequest withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
- Parameters:
exclusiveStartKey
- The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addExclusiveStartKeyEntry
public ScanRequest addExclusiveStartKeyEntry(String key, AttributeValue value)
-
clearExclusiveStartKeyEntries
public ScanRequest clearExclusiveStartKeyEntries()
Removes all the entries added into ExclusiveStartKey. <p> Returns a reference to this object so that method calls can be chained together.
-
setReturnConsumedCapacity
public void setReturnConsumedCapacity(String returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- See Also:
ReturnConsumedCapacity
-
getReturnConsumedCapacity
public String getReturnConsumedCapacity()
- Returns:
- See Also:
ReturnConsumedCapacity
-
withReturnConsumedCapacity
public ScanRequest withReturnConsumedCapacity(String returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ReturnConsumedCapacity
-
setReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- See Also:
ReturnConsumedCapacity
-
withReturnConsumedCapacity
public ScanRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ReturnConsumedCapacity
-
setTotalSegments
public void setTotalSegments(Integer totalSegments)
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
- Parameters:
totalSegments
- For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
-
getTotalSegments
public Integer getTotalSegments()
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
- Returns:
- For a parallel Scan request, TotalSegments
represents the total number of segments into which the
Scan operation will be divided. The value of
TotalSegments corresponds to the number of application
workers that will perform the parallel scan. For example, if you
want to use four application threads to scan a table or an index,
specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
-
withTotalSegments
public ScanRequest withTotalSegments(Integer totalSegments)
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
- Parameters:
totalSegments
- For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSegment
public void setSegment(Integer segment)
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
- Parameters:
segment
- For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
-
getSegment
public Integer getSegment()
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
- Returns:
- For a parallel Scan request, Segment identifies an
individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
-
withSegment
public ScanRequest withSegment(Integer segment)
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
- Parameters:
segment
- For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProjectionExpression
public void setProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
- Parameters:
projectionExpression
- A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
-
getProjectionExpression
public String getProjectionExpression()
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
- Returns:
- A string that identifies one or more attributes to retrieve from
the specified table or index. These attributes can include
scalars, sets, or elements of a JSON document. The attributes in
the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
-
withProjectionExpression
public ScanRequest withProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
- Parameters:
projectionExpression
- A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFilterExpression
public void setFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
- Parameters:
filterExpression
- A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
-
getFilterExpression
public String getFilterExpression()
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
- Returns:
- A string that contains conditions that DynamoDB applies after the
Scan operation, but before the data is returned to you.
Items that do not satisfy the FilterExpression criteria
are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
-
withFilterExpression
public ScanRequest withFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
- Parameters:
filterExpression
- A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getExpressionAttributeNames
public Map<String,String> getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
- Returns:
- One or more substitution tokens for attribute names in an
expression. The following are some use cases for using
ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
-
-
-
setExpressionAttributeNames
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
-
-
-
withExpressionAttributeNames
public ScanRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:-
To access an attribute whose name conflicts with a DynamoDB reserved word.
-
To create a placeholder for repeating occurrences of an attribute name in an expression.
-
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
-
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
-
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
-
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addExpressionAttributeNamesEntry
public ScanRequest addExpressionAttributeNamesEntry(String key, String value)
-
clearExpressionAttributeNamesEntries
public ScanRequest clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames. <p> Returns a reference to this object so that method calls can be chained together.
-
getExpressionAttributeValues
public Map<String,AttributeValue> getExpressionAttributeValues()
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Returns:
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
-
setExpressionAttributeValues
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeValues
- One or more values that can be substituted in an expression.Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
-
withExpressionAttributeValues
public ScanRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeValues
- One or more values that can be substituted in an expression.Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addExpressionAttributeValuesEntry
public ScanRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
-
clearExpressionAttributeValuesEntries
public ScanRequest clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues. <p> Returns a reference to this object so that method calls can be chained together.
-
setConsistentRead
public void setConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:
-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
- Parameters:
consistentRead
- A Boolean value that determines the read consistency model during the scan:-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
-
-
-
getConsistentRead
public Boolean getConsistentRead()
A Boolean value that determines the read consistency model during the scan:
-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
- Returns:
- A Boolean value that determines the read consistency model during
the scan:
-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
-
-
-
withConsistentRead
public ScanRequest withConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:
-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
- Parameters:
consistentRead
- A Boolean value that determines the read consistency model during the scan:-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
isConsistentRead
public Boolean isConsistentRead()
A Boolean value that determines the read consistency model during the scan:
-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
- Returns:
- A Boolean value that determines the read consistency model during
the scan:
-
If ConsistentRead is
false
, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). -
If ConsistentRead is
true
, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is
false
.The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
-
-
-
setExclusiveStartKey
public void setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The primary hash and range keys of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
- Parameters:
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.- Throws:
IllegalArgumentException
-
withExclusiveStartKey
public ScanRequest withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The primary hash and range keys of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
Returns a reference to this object so that method calls can be chained together.
- Parameters:
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.- Throws:
IllegalArgumentException
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ScanRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-