ScanRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.dynamodbv2.model.ScanRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ScanRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single Scan operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScanRequest()
Default constructor for ScanRequest object.

ScanRequest(java.lang.String tableName)
Constructs a new ScanRequest object.

Constructors
Constructor and Description
`ScanRequest()` Default constructor for ScanRequest object.
`ScanRequest(java.lang.String tableName)` Constructs a new ScanRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScanRequest`	`addExclusiveStartKeyEntry(java.lang.String key, AttributeValue value)` The primary key of the first item that this operation will evaluate.
`ScanRequest`	`addExpressionAttributeNamesEntry(java.lang.String key, java.lang.String value)` One or more substitution tokens for attribute names in an expression.
`ScanRequest`	`addExpressionAttributeValuesEntry(java.lang.String key, AttributeValue value)` One or more values that can be substituted in an expression.
`ScanRequest`	`addScanFilterEntry(java.lang.String key, Condition value)` This is a legacy parameter.
`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.
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getAttributesToGet()` This is a legacy parameter.
`java.lang.String`	`getConditionalOperator()` This is a legacy parameter.
`java.lang.Boolean`	`getConsistentRead()` A Boolean value that determines the read consistency model during the scan:
`java.util.Map<java.lang.String,AttributeValue>`	`getExclusiveStartKey()` The primary key of the first item that this operation will evaluate.
`java.util.Map<java.lang.String,java.lang.String>`	`getExpressionAttributeNames()` One or more substitution tokens for attribute names in an expression.
`java.util.Map<java.lang.String,AttributeValue>`	`getExpressionAttributeValues()` One or more values that can be substituted in an expression.
`java.lang.String`	`getFilterExpression()` A string that contains conditions that DynamoDB applies after the `Scan` operation, but before the data is returned to you.
`java.lang.String`	`getIndexName()` The name of a secondary index to scan.
`java.lang.Integer`	`getLimit()` The maximum number of items to evaluate (not necessarily the number of matching items).
`java.lang.String`	`getProjectionExpression()` A string that identifies one or more attributes to retrieve from the specified table or index.
`java.lang.String`	`getReturnConsumedCapacity()` Determines the level of detail about provisioned throughput consumption that is returned in the response:
`java.util.Map<java.lang.String,Condition>`	`getScanFilter()` This is a legacy parameter.
`java.lang.Integer`	`getSegment()` For a parallel `Scan` request, `Segment` identifies an individual segment to be scanned by an application worker.
`java.lang.String`	`getSelect()` The attributes to be returned in the result.
`java.lang.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.
`java.lang.Integer`	`getTotalSegments()` For a parallel `Scan` request, `TotalSegments` represents the total number of segments into which the `Scan` operation will be divided.
`int`	`hashCode()`
`java.lang.Boolean`	`isConsistentRead()` A Boolean value that determines the read consistency model during the scan:
`void`	`setAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)` This is a legacy parameter.
`void`	`setConditionalOperator(ConditionalOperator conditionalOperator)` This is a legacy parameter.
`void`	`setConditionalOperator(java.lang.String conditionalOperator)` This is a legacy parameter.
`void`	`setConsistentRead(java.lang.Boolean consistentRead)` A Boolean value that determines the read consistency model during the scan:
`void`	`setExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)` The primary key of the first item that this operation will evaluate.
`void`	`setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`void`	`setExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`void`	`setFilterExpression(java.lang.String filterExpression)` A string that contains conditions that DynamoDB applies after the `Scan` operation, but before the data is returned to you.
`void`	`setIndexName(java.lang.String indexName)` The name of a secondary index to scan.
`void`	`setLimit(java.lang.Integer limit)` The maximum number of items to evaluate (not necessarily the number of matching items).
`void`	`setProjectionExpression(java.lang.String projectionExpression)` A string that identifies one or more attributes to retrieve from the specified table or index.
`void`	`setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)` Determines the level of detail about provisioned throughput consumption that is returned in the response:
`void`	`setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)` Determines the level of detail about provisioned throughput consumption that is returned in the response:
`void`	`setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)` This is a legacy parameter.
`void`	`setSegment(java.lang.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(java.lang.String select)` The attributes to be returned in the result.
`void`	`setTableName(java.lang.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.
`void`	`setTotalSegments(java.lang.Integer totalSegments)` For a parallel `Scan` request, `TotalSegments` represents the total number of segments into which the `Scan` operation will be divided.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ScanRequest`	`withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)` This is a legacy parameter.
`ScanRequest`	`withAttributesToGet(java.lang.String... attributesToGet)` This is a legacy parameter.
`ScanRequest`	`withConditionalOperator(ConditionalOperator conditionalOperator)` This is a legacy parameter.
`ScanRequest`	`withConditionalOperator(java.lang.String conditionalOperator)` This is a legacy parameter.
`ScanRequest`	`withConsistentRead(java.lang.Boolean consistentRead)` A Boolean value that determines the read consistency model during the scan:
`ScanRequest`	`withExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)` The primary key of the first item that this operation will evaluate.
`ScanRequest`	`withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`ScanRequest`	`withExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`ScanRequest`	`withFilterExpression(java.lang.String filterExpression)` A string that contains conditions that DynamoDB applies after the `Scan` operation, but before the data is returned to you.
`ScanRequest`	`withIndexName(java.lang.String indexName)` The name of a secondary index to scan.
`ScanRequest`	`withLimit(java.lang.Integer limit)` The maximum number of items to evaluate (not necessarily the number of matching items).
`ScanRequest`	`withProjectionExpression(java.lang.String projectionExpression)` A string that identifies one or more attributes to retrieve from the specified table or index.
`ScanRequest`	`withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)` Determines the level of detail about provisioned throughput consumption that is returned in the response:
`ScanRequest`	`withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)` Determines the level of detail about provisioned throughput consumption that is returned in the response:
`ScanRequest`	`withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)` This is a legacy parameter.
`ScanRequest`	`withSegment(java.lang.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(java.lang.String select)` The attributes to be returned in the result.
`ScanRequest`	`withTableName(java.lang.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.
`ScanRequest`	`withTotalSegments(java.lang.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
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ScanRequest
```
public ScanRequest()
```
    Default constructor for ScanRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
  - ScanRequest
```
public ScanRequest(java.lang.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 provide IndexName, the name of the table to which that index belongs.
- Method Detail
  - getTableName
```
public java.lang.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.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    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.
  - setTableName
```
public void setTableName(java.lang.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.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    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.
  - withTableName
```
public ScanRequest withTableName(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIndexName
```
public java.lang.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 provide TableName.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    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 provide TableName.
  - setIndexName
```
public void setIndexName(java.lang.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 provide TableName.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    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 the IndexName parameter, you must also provide TableName.
  - withIndexName
```
public ScanRequest withIndexName(java.lang.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 provide TableName.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    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 the IndexName parameter, you must also provide TableName.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributesToGet
```
public java.util.List<java.lang.String> getAttributesToGet()
```
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
  - setAttributesToGet
```
public void setAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
```
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    attributesToGet -
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
  - withAttributesToGet
```
public ScanRequest withAttributesToGet(java.lang.String... attributesToGet)
```
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributesToGet -
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAttributesToGet
```
public ScanRequest withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
```
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributesToGet -
    This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLimit
```
public java.lang.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.
    
    Constraints:
    Range: 1 -
    
    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.
  - setLimit
```
public void setLimit(java.lang.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.
    
    Constraints:
    Range: 1 -
    
    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.
  - withLimit
```
public ScanRequest withLimit(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSelect
```
public java.lang.String getSelect()
```
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    - ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    - 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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
      
      If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    
    Constraints:
    Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
    Returns:
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    
    ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    
    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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
    
    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    See Also:
    
    Select
  - setSelect
```
public void setSelect(java.lang.String select)
```
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    - ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    - 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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
      
      If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    
    Constraints:
    Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
    Parameters:
    select -
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    
    ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    
    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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
    
    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    See Also:
    
    Select
  - withSelect
```
public ScanRequest withSelect(java.lang.String select)
```
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    - ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    - 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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
      
      If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
    Parameters:
    select -
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    
    ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    
    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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
    
    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    Returns:
    
    A reference to this updated 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, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    - ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    - 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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
      
      If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    
    Constraints:
    Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
    Parameters:
    select -
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    
    ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    
    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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
    
    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    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, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    - ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    - 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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
      
      If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
    Parameters:
    select -
    The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
    
    ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
    
    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 specifying ALL_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 you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
    
    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
    
    If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
    
    If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Select
  - getScanFilter
```
public java.util.Map<java.lang.String,Condition> getScanFilter()
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
  - setScanFilter
```
public void setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    scanFilter -
    This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
  - withScanFilter
```
public ScanRequest withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    scanFilter -
    This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addScanFilterEntry
```
public ScanRequest addScanFilterEntry(java.lang.String key,
                                      Condition value)
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
    
    The method adds a new key-value pair into ScanFilter parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into ScanFilter.
    
    value - The corresponding value of the entry to be added into ScanFilter.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearScanFilterEntries
```
public ScanRequest clearScanFilterEntries()
```
    Removes all the entries added into ScanFilter.
    Returns a reference to this object so that method calls can be chained together.
  - getConditionalOperator
```
public java.lang.String getConditionalOperator()
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Constraints:
    Allowed Values: AND, OR
    
    Returns:
    
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - setConditionalOperator
```
public void setConditionalOperator(java.lang.String conditionalOperator)
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Constraints:
    Allowed Values: AND, OR
    
    Parameters:
    
    conditionalOperator -
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - withConditionalOperator
```
public ScanRequest withConditionalOperator(java.lang.String conditionalOperator)
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AND, OR
    
    Parameters:
    
    conditionalOperator -
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator
  - setConditionalOperator
```
public void setConditionalOperator(ConditionalOperator conditionalOperator)
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Constraints:
    Allowed Values: AND, OR
    
    Parameters:
    
    conditionalOperator -
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - withConditionalOperator
```
public ScanRequest withConditionalOperator(ConditionalOperator conditionalOperator)
```
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AND, OR
    
    Parameters:
    
    conditionalOperator -
    This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator
  - getExclusiveStartKey
```
public java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.util.Map<java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - addExclusiveStartKeyEntry
```
public ScanRequest addExclusiveStartKeyEntry(java.lang.String key,
                                             AttributeValue value)
```
    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.
    
    The method adds a new key-value pair into ExclusiveStartKey parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into ExclusiveStartKey.
    
    value - The corresponding value of the entry to be added into ExclusiveStartKey.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearExclusiveStartKeyEntries
```
public ScanRequest clearExclusiveStartKeyEntries()
```
    Removes all the entries added into ExclusiveStartKey.
    Returns a reference to this object so that method calls can be chained together.
  - getReturnConsumedCapacity
```
public java.lang.String getReturnConsumedCapacity()
```
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    - INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
      
      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    - TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    - NONE - No ConsumedCapacity details are included in the response.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    Returns:
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    
    INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
    
    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    
    TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    
    NONE - No ConsumedCapacity details are included in the response.
    See Also:
    
    ReturnConsumedCapacity
  - setReturnConsumedCapacity
```
public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
```
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    - INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
      
      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    - TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    - NONE - No ConsumedCapacity details are included in the response.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    Parameters:
    returnConsumedCapacity -
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    
    INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
    
    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    
    TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    
    NONE - No ConsumedCapacity details are included in the response.
    See Also:
    
    ReturnConsumedCapacity
  - withReturnConsumedCapacity
```
public ScanRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
```
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    - INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
      
      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    - TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    - NONE - No ConsumedCapacity details are included in the response.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    Parameters:
    returnConsumedCapacity -
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    
    INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
    
    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    
    TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    
    NONE - No ConsumedCapacity details are included in the response.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ReturnConsumedCapacity
  - setReturnConsumedCapacity
```
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
```
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    - INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
      
      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    - TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    - NONE - No ConsumedCapacity details are included in the response.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    Parameters:
    returnConsumedCapacity -
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    
    INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
    
    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    
    TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    
    NONE - No ConsumedCapacity details are included in the response.
    See Also:
    
    ReturnConsumedCapacity
  - withReturnConsumedCapacity
```
public ScanRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
```
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    - INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
      
      Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    - TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    - NONE - No ConsumedCapacity details are included in the response.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    Parameters:
    returnConsumedCapacity -
    Determines the level of detail about provisioned throughput consumption that is returned in the response:
    
    INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
    
    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
    
    TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
    
    NONE - No ConsumedCapacity details are included in the response.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ReturnConsumedCapacity
  - getTotalSegments
```
public java.lang.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.
    
    Constraints:
    Range: 1 - 1000000
    
    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.
  - setTotalSegments
```
public void setTotalSegments(java.lang.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.
    
    Constraints:
    Range: 1 - 1000000
    
    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.
  - withTotalSegments
```
public ScanRequest withTotalSegments(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 1000000
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSegment
```
public java.lang.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.
    
    Constraints:
    Range: 0 - 999999
    
    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.
  - setSegment
```
public void setSegment(java.lang.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.
    
    Constraints:
    Range: 0 - 999999
    
    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.
  - withSegment
```
public ScanRequest withSegment(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 - 999999
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getProjectionExpression
```
public java.lang.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.
    
    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.
  - setProjectionExpression
```
public void setProjectionExpression(java.lang.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.
    
    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.
  - withProjectionExpression
```
public ScanRequest withProjectionExpression(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFilterExpression
```
public java.lang.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.
    
    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.
  - setFilterExpression
```
public void setFilterExpression(java.lang.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.
    
    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.
  - withFilterExpression
```
public ScanRequest withFilterExpression(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExpressionAttributeNames
```
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - addExpressionAttributeNamesEntry
```
public ScanRequest addExpressionAttributeNamesEntry(java.lang.String key,
                                                    java.lang.String value)
```
    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.
    
    The method adds a new key-value pair into ExpressionAttributeNames parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    
    key - The key of the entry to be added into ExpressionAttributeNames.
    
    value - The corresponding value of the entry to be added into ExpressionAttributeNames.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearExpressionAttributeNamesEntries
```
public ScanRequest clearExpressionAttributeNamesEntries()
```
    Removes all the entries added into ExpressionAttributeNames.
    Returns a reference to this object so that method calls can be chained together.
  - getExpressionAttributeValues
```
public java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.util.Map<java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - addExpressionAttributeValuesEntry
```
public ScanRequest addExpressionAttributeValuesEntry(java.lang.String key,
                                                     AttributeValue value)
```
    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.
    
    The method adds a new key-value pair into ExpressionAttributeValues parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into ExpressionAttributeValues.
    
    value - The corresponding value of the entry to be added into ExpressionAttributeValues.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearExpressionAttributeValuesEntries
```
public ScanRequest clearExpressionAttributeValuesEntries()
```
    Removes all the entries added into ExpressionAttributeValues.
    Returns a reference to this object so that method calls can be chained together.
  - isConsistentRead
```
public java.lang.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.
  - getConsistentRead
```
public java.lang.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.
  - setConsistentRead
```
public void setConsistentRead(java.lang.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.
  - withConsistentRead
```
public ScanRequest withConsistentRead(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ScanRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ScanRequest

ScanRequest

Method Detail

getTableName

setTableName

withTableName

getIndexName

setIndexName

withIndexName

getAttributesToGet

setAttributesToGet

withAttributesToGet

withAttributesToGet

getLimit

setLimit

withLimit

getSelect

setSelect

withSelect

setSelect

withSelect

getScanFilter

setScanFilter

withScanFilter

addScanFilterEntry

clearScanFilterEntries

getConditionalOperator

setConditionalOperator

withConditionalOperator

setConditionalOperator

withConditionalOperator

getExclusiveStartKey

setExclusiveStartKey

withExclusiveStartKey

addExclusiveStartKeyEntry

clearExclusiveStartKeyEntries

getReturnConsumedCapacity

setReturnConsumedCapacity

withReturnConsumedCapacity

setReturnConsumedCapacity

withReturnConsumedCapacity

getTotalSegments

setTotalSegments

withTotalSegments

getSegment

setSegment

withSegment

getProjectionExpression

setProjectionExpression

withProjectionExpression

getFilterExpression

setFilterExpression

withFilterExpression

getExpressionAttributeNames

setExpressionAttributeNames

withExpressionAttributeNames

addExpressionAttributeNamesEntry

clearExpressionAttributeNamesEntries

getExpressionAttributeValues

setExpressionAttributeValues

withExpressionAttributeValues

addExpressionAttributeValuesEntry

clearExpressionAttributeValuesEntries

isConsistentRead

getConsistentRead

setConsistentRead

withConsistentRead

toString

hashCode

equals