/* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.dynamodbv2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* 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. *

*/ public class ScanRequest extends AmazonWebServiceRequest implements Serializable { /** *

* 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_.-]+
*/ private String tableName; /** *

* 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_.-]+
*/ private String indexName; /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

*/ private java.util.List attributesToGet; /** *

* 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 -
*/ private Integer limit; /** *

* 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 */ private String select; /** *

* This is a legacy parameter. Use FilterExpression instead. * For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. *

*/ private java.util.Map scanFilter; /** *

* This is a legacy parameter. Use FilterExpression instead. * For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* Constraints:
* Allowed Values: AND, OR */ private String conditionalOperator; /** *

* 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. *

*/ private java.util.Map exclusiveStartKey; /** *

* 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 */ private String returnConsumedCapacity; /** *

* 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
*/ private Integer totalSegments; /** *

* 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
*/ private Integer segment; /** *

* 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. *

*/ private String projectionExpression; /** *

* 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. *

*/ private String filterExpression; /** *

* 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. *

*/ private java.util.Map expressionAttributeNames; /** *

* 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. *

*/ private java.util.Map expressionAttributeValues; /** *

* 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. *

*/ private Boolean consistentRead; /** * Default constructor for ScanRequest object. Callers should use the setter * or fluent setter (with...) methods to initialize any additional object * members. */ public ScanRequest() { } /** * Constructs a new ScanRequest object. Callers should use the setter or * fluent setter (with...) methods to initialize any additional object * members. * * @param 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. *

*/ public ScanRequest(String tableName) { setTableName(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_.-]+
* * @return

* The name of the table containing the requested items; or, if you * provide IndexName, the name of the table to which * that index belongs. *

*/ public String getTableName() { return 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_.-]+
* * @param 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. *

*/ public void setTableName(String tableName) { this.tableName = 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_.-]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withTableName(String tableName) { this.tableName = tableName; return this; } /** *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @return

* 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. *

*/ public String getIndexName() { return indexName; } /** *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @param 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. *

*/ public void setIndexName(String indexName) { this.indexName = indexName; } /** *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @param indexName

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withIndexName(String indexName) { this.indexName = indexName; return this; } /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

* * @return

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

*/ public java.util.List getAttributesToGet() { return attributesToGet; } /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

* * @param attributesToGet

* This is a legacy parameter. Use * ProjectionExpression instead. For more * information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

*/ public void setAttributesToGet(java.util.Collection attributesToGet) { if (attributesToGet == null) { this.attributesToGet = null; return; } this.attributesToGet = new java.util.ArrayList(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. * * @param attributesToGet

* This is a legacy parameter. Use * ProjectionExpression instead. For more * information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withAttributesToGet(String... attributesToGet) { if (getAttributesToGet() == null) { this.attributesToGet = new java.util.ArrayList(attributesToGet.length); } for (String value : attributesToGet) { this.attributesToGet.add(value); } return this; } /** *

* 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. * * @param attributesToGet

* This is a legacy parameter. Use * ProjectionExpression instead. For more * information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withAttributesToGet(java.util.Collection attributesToGet) { setAttributesToGet(attributesToGet); return this; } /** *

* Constraints:
* Range: 1 -
* * @return

* 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. *

*/ public Integer getLimit() { return limit; } /** *

* Constraints:
* Range: 1 -
* * @param 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. *

*/ public void setLimit(Integer limit) { this.limit = limit; } /** *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 -
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withLimit(Integer limit) { this.limit = limit; return this; } /** *

*
* 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 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 * * @return

* 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 Select */ public String getSelect() { return select; } /** *

*
* 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 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 * * @param 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 Select */ public void setSelect(String select) { this.select = select; } /** *

*
* 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 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 * * @param select

*
* 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 you use the ProjectionExpression parameter, * then the value for Select can only be * SPECIFIC_ATTRIBUTES. Any other value for * Select will return an error. *

* * @return A reference to this updated object so that method calls can be * chained together. * @see Select */ public ScanRequest withSelect(String select) { this.select = select; return this; } /** *

*
* 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 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 * * @param select

*
* 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 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 Select */ public void setSelect(Select select) { this.select = select.toString(); } /** *

*
* 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 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 * * @param select

*
* 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 you use the ProjectionExpression parameter, * then the value for Select can only be * SPECIFIC_ATTRIBUTES. Any other value for * Select will return an error. *

* * @return A reference to this updated object so that method calls can be * chained together. * @see Select */ public ScanRequest withSelect(Select select) { this.select = select.toString(); return this; } /** *

* This is a legacy parameter. Use FilterExpression instead. * For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. *

* * @return

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. *

*/ public java.util.Map getScanFilter() { return scanFilter; } /** *

* This is a legacy parameter. Use FilterExpression instead. * For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. *

* * @param scanFilter

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. *

*/ public void setScanFilter(java.util.Map scanFilter) { this.scanFilter = 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. * * @param scanFilter

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withScanFilter(java.util.Map scanFilter) { this.scanFilter = scanFilter; return this; } /** *

* 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. * * @param key The key of the entry to be added into ScanFilter. * @param value The corresponding value of the entry to be added into * ScanFilter. * @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest addScanFilterEntry(String key, Condition value) { if (null == this.scanFilter) { this.scanFilter = new java.util.HashMap(); } if (this.scanFilter.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.scanFilter.put(key, value); return this; } /** * Removes all the entries added into ScanFilter. *

* Returns a reference to this object so that method calls can be chained * together. */ public ScanRequest clearScanFilterEntries() { this.scanFilter = null; return this; } /** *

* This is a legacy parameter. Use FilterExpression instead. * For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* Constraints:
* Allowed Values: AND, OR * * @return

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer * Guide. *

* @see ConditionalOperator */ public String getConditionalOperator() { return 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 * * @param conditionalOperator

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer * Guide. *

* @see ConditionalOperator */ public void setConditionalOperator(String conditionalOperator) { this.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 * * @param conditionalOperator

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ConditionalOperator */ public ScanRequest withConditionalOperator(String conditionalOperator) { this.conditionalOperator = conditionalOperator; return this; } /** *

* This is a legacy parameter. Use FilterExpression instead. * For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* Constraints:
* Allowed Values: AND, OR * * @param conditionalOperator

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer * Guide. *

* @see ConditionalOperator */ public void setConditionalOperator(ConditionalOperator conditionalOperator) { this.conditionalOperator = conditionalOperator.toString(); } /** *

* 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 * * @param conditionalOperator

* This is a legacy parameter. Use FilterExpression * instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ConditionalOperator */ public ScanRequest withConditionalOperator(ConditionalOperator conditionalOperator) { this.conditionalOperator = conditionalOperator.toString(); return this; } /** *

* 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. *

* * @return

* 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. *

*/ public java.util.Map getExclusiveStartKey() { return 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. *

* * @param 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. *

*/ public void setExclusiveStartKey(java.util.Map exclusiveStartKey) { this.exclusiveStartKey = 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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withExclusiveStartKey(java.util.Map exclusiveStartKey) { this.exclusiveStartKey = exclusiveStartKey; return this; } /** *

* 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. * * @param key The key of the entry to be added into ExclusiveStartKey. * @param value The corresponding value of the entry to be added into * ExclusiveStartKey. * @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest addExclusiveStartKeyEntry(String key, AttributeValue value) { if (null == this.exclusiveStartKey) { this.exclusiveStartKey = new java.util.HashMap(); } if (this.exclusiveStartKey.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.exclusiveStartKey.put(key, value); return this; } /** * Removes all the entries added into ExclusiveStartKey. *

* Returns a reference to this object so that method calls can be chained * together. */ public ScanRequest clearExclusiveStartKeyEntries() { this.exclusiveStartKey = null; return this; } /** *

* 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 * * @return

* 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 ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return 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 * * @param 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 ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.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 * * @param 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. *
*

* @return A reference to this updated object so that method calls can be * chained together. * @see ReturnConsumedCapacity */ public ScanRequest withReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; return this; } /** *

* 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 * * @param 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 ReturnConsumedCapacity */ public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); } /** *

* 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 * * @param 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. *
*

* @return A reference to this updated object so that method calls can be * chained together. * @see ReturnConsumedCapacity */ public ScanRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); return this; } /** *

* If you specify TotalSegments, you must also specify * Segment. *

* Constraints:
* Range: 1 - 1000000
* * @return

* 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. *

*/ public Integer getTotalSegments() { return totalSegments; } /** *

* If you specify TotalSegments, you must also specify * Segment. *

* Constraints:
* Range: 1 - 1000000
* * @param 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. *

*/ public void setTotalSegments(Integer totalSegments) { this.totalSegments = totalSegments; } /** *

* 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
* * @param 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. *

* If you specify TotalSegments, you must also * specify Segment. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ScanRequest withTotalSegments(Integer totalSegments) { this.totalSegments = totalSegments; return this; } /** *

* For a parallel Scan request, Segment identifies * an individual segment to be scanned by an application worker. *

* 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
* * @return

* 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. *

*/ public Integer getSegment() { return segment; } /** *

* For a parallel Scan request, Segment identifies * an individual segment to be scanned by an application worker. *

* 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
* * @param 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. *

*/ public void setSegment(Integer segment) { this.segment = segment; } /** *