/* * Copyright 2018-2023 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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Represents the input of a Scan operation. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ScanRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

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

*/ 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 dataset 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 Working with * Queries in the Amazon DynamoDB Developer Guide. *

*/ 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 fetches 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. Note that * this uses the same quantity of read capacity units as getting the items, and is subject to the same item size * calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This * return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not projected into the * local secondary index, DynamoDB fetches 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 ProjectionExpression 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 ProjectionExpression together in a single * request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent * to specifying ProjectionExpression 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. *

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

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

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

*/ 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 Specifying 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 Specifying 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 Condition Expressions 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 the object after creating it. */ 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. *

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

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

* * @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 Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withTableName(String tableName) { setTableName(tableName); return this; } /** *

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

* * @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; } /** *

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

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

* * @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. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withIndexName(String indexName) { setIndexName(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. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setAttributesToGet(java.util.Collection)} or {@link #withAttributesToGet(java.util.Collection)} if you * want to override the existing values. *

* * @param attributesToGet * This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withAttributesToGet(String... attributesToGet) { if (this.attributesToGet == null) { setAttributesToGet(new java.util.ArrayList(attributesToGet.length)); } for (String ele : attributesToGet) { this.attributesToGet.add(ele); } return this; } /** *

* 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withAttributesToGet(java.util.Collection attributesToGet) { setAttributesToGet(attributesToGet); return this; } /** *

* * @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 dataset 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 Working with * Queries in the Amazon DynamoDB Developer Guide. */ public void setLimit(Integer limit) { this.limit = limit; } /** *

* * @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 dataset 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 Working with * Queries in the Amazon DynamoDB Developer Guide. */ public Integer getLimit() { return this.limit; } /** *

* * @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 dataset 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 Working with * Queries in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withLimit(Integer limit) { setLimit(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 fetches 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. Note that * this uses the same quantity of read capacity units as getting the items, and is subject to the same item size * calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This * return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not projected into the * local secondary index, DynamoDB fetches 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. *

* * * @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 fetches 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. Note * that this uses the same quantity of read capacity units as getting the items, and is subject to the same * item size calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression * . This return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not * projected into the local secondary index, DynamoDB fetches 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 ProjectionExpression 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 ProjectionExpression together * in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This * usage is equivalent to specifying ProjectionExpression 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 fetches 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. Note that * this uses the same quantity of read capacity units as getting the items, and is subject to the same item size * calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This * return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not projected into the * local secondary index, DynamoDB fetches 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 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 fetches 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. * Note that this uses the same quantity of read capacity units as getting the items, and is subject to the * same item size calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in * ProjectionExpression. This return value is equivalent to specifying * ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not * projected into the local secondary index, DynamoDB fetches 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 ProjectionExpression 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 ProjectionExpression * together in a single request, unless the value for Select is * SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying * ProjectionExpression 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 this.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 fetches 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. Note that * this uses the same quantity of read capacity units as getting the items, and is subject to the same item size * calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This * return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not projected into the * local secondary index, DynamoDB fetches 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. *

*
* 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 fetches 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. Note * that this uses the same quantity of read capacity units as getting the items, and is subject to the same * item size calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression * . This return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not * projected into the local secondary index, DynamoDB fetches 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 Returns a reference to this object so that method calls can be chained together. * @see Select */ public ScanRequest withSelect(String select) { setSelect(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 fetches 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. Note that * this uses the same quantity of read capacity units as getting the items, and is subject to the same item size * calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This * return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not projected into the * local secondary index, DynamoDB fetches 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. *

*
* 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 fetches 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. Note * that this uses the same quantity of read capacity units as getting the items, and is subject to the same * item size calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression * . This return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not * projected into the local secondary index, DynamoDB fetches 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) { withSelect(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 fetches 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. Note that * this uses the same quantity of read capacity units as getting the items, and is subject to the same item size * calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This * return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not projected into the * local secondary index, DynamoDB fetches 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. *

*
* 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 fetches 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. Note * that this uses the same quantity of read capacity units as getting the items, and is subject to the same * item size calculations. *
*
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression * . This return value is equivalent to specifying ProjectionExpression 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 reads only the index and not the table. If any of the requested attributes are not * projected into the local secondary index, DynamoDB fetches 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 Returns a reference to this 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. *

* * @param scanFilter * This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withScanFilter(java.util.Map scanFilter) { setScanFilter(scanFilter); return this; } /** * Add a single ScanFilter entry * * @see ScanRequest#withScanFilter * @returns a reference to this 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. * * @return 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. *

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

* * @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 this.conditionalOperator; } /** *

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

* * @param conditionalOperator * This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see ConditionalOperator */ public ScanRequest withConditionalOperator(String conditionalOperator) { setConditionalOperator(conditionalOperator); return this; } /** *

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

* * @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) { withConditionalOperator(conditionalOperator); } /** *

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

* * @param conditionalOperator * This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this 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. *

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

* 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withExclusiveStartKey(java.util.Map exclusiveStartKey) { setExclusiveStartKey(exclusiveStartKey); return this; } /** * Add a single ExclusiveStartKey entry * * @see ScanRequest#withExclusiveStartKey * @returns a reference to this 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. * * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest clearExclusiveStartKeyEntries() { this.exclusiveStartKey = null; return this; } /** * @param returnConsumedCapacity * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; } /** * @return * @see ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return this.returnConsumedCapacity; } /** * @param returnConsumedCapacity * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnConsumedCapacity */ public ScanRequest withReturnConsumedCapacity(String returnConsumedCapacity) { setReturnConsumedCapacity(returnConsumedCapacity); return this; } /** * @param returnConsumedCapacity * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { withReturnConsumedCapacity(returnConsumedCapacity); } /** * @param returnConsumedCapacity * @return Returns a reference to this 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. *

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

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

* If you specify TotalSegments, you must also specify Segment. */ public Integer getTotalSegments() { return this.totalSegments; } /** *

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

* If you specify TotalSegments, you must also specify Segment. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withTotalSegments(Integer totalSegments) { setTotalSegments(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. *

* * @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; } /** *

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

* * @return 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. */ public Integer getSegment() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withSegment(Integer segment) { setSegment(segment); return this; } /** *

* 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* * @param 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. */ public void setProjectionExpression(String projectionExpression) { this.projectionExpression = projectionExpression; } /** *

* 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* * @return 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. */ public String getProjectionExpression() { return this.projectionExpression; } /** *

* 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withProjectionExpression(String projectionExpression) { setProjectionExpression(projectionExpression); return this; } /** *

* *

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

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

* *

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

* * @return 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. */ public String getFilterExpression() { return this.filterExpression; } /** *

* *

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

* 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withFilterExpression(String filterExpression) { setFilterExpression(filterExpression); return this; } /** *

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

*
* {"#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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* * @return 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. */ public java.util.Map getExpressionAttributeNames() { return 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 *
*

*
* {"#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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* * @param 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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. */ public void setExpressionAttributeNames(java.util.Map expressionAttributeNames) { this.expressionAttributeNames = 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 *
*

*
* {"#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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

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

*
* {"#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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withExpressionAttributeNames(java.util.Map expressionAttributeNames) { setExpressionAttributeNames(expressionAttributeNames); return this; } /** * Add a single ExpressionAttributeNames entry * * @see ScanRequest#withExpressionAttributeNames * @returns a reference to this object so that method calls can be chained together. */ public ScanRequest addExpressionAttributeNamesEntry(String key, String value) { if (null == this.expressionAttributeNames) { this.expressionAttributeNames = new java.util.HashMap(); } if (this.expressionAttributeNames.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeNames.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeNames. * * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest clearExpressionAttributeNamesEntries() { this.expressionAttributeNames = null; return this; } /** *

* One or more values that can be substituted in an expression. *

* 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 Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @return 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 Condition Expressions in the Amazon DynamoDB Developer Guide. */ public java.util.Map getExpressionAttributeValues() { return expressionAttributeValues; } /** *

* One or more values that can be substituted in an expression. *

* 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 Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @param expressionAttributeValues * One or more values that can be substituted in an expression.

* 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 Condition Expressions in the Amazon DynamoDB Developer Guide. */ public void setExpressionAttributeValues(java.util.Map expressionAttributeValues) { this.expressionAttributeValues = expressionAttributeValues; } /** *

* One or more values that can be substituted in an expression. *

* 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 Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @param expressionAttributeValues * One or more values that can be substituted in an expression.

* 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 Condition Expressions in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withExpressionAttributeValues(java.util.Map expressionAttributeValues) { setExpressionAttributeValues(expressionAttributeValues); return this; } /** * Add a single ExpressionAttributeValues entry * * @see ScanRequest#withExpressionAttributeValues * @returns a reference to this object so that method calls can be chained together. */ public ScanRequest addExpressionAttributeValuesEntry(String key, AttributeValue value) { if (null == this.expressionAttributeValues) { this.expressionAttributeValues = new java.util.HashMap(); } if (this.expressionAttributeValues.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeValues.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeValues. * * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest clearExpressionAttributeValuesEntries() { this.expressionAttributeValues = null; return this; } /** *

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

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

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

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

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

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ScanRequest withConsistentRead(Boolean consistentRead) { setConsistentRead(consistentRead); return this; } /** *

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

* * @return 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. */ public Boolean isConsistentRead() { return this.consistentRead; } /** * The primary hash and range keys of the first item that this operation will evaluate. Use the value that was * returned for LastEvaluatedKey in the previous operation. *

* The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed. * * @param hashKey * a map entry including the name and value of the primary hash key. * @param rangeKey * a map entry including the name and value of the primary range key, or null if it is a hash-only table. */ public void setExclusiveStartKey(java.util.Map.Entry hashKey, java.util.Map.Entry rangeKey) throws IllegalArgumentException { java.util.HashMap exclusiveStartKey = new java.util.HashMap(); if (hashKey != null) { exclusiveStartKey.put(hashKey.getKey(), hashKey.getValue()); } else { throw new IllegalArgumentException("hashKey must be non-null object."); } if (rangeKey != null) { exclusiveStartKey.put(rangeKey.getKey(), rangeKey.getValue()); } setExclusiveStartKey(exclusiveStartKey); } /** * The primary hash and range keys of the first item that this operation will evaluate. Use the value that was * returned for LastEvaluatedKey in the previous operation. *

* The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed. *

* Returns a reference to this object so that method calls can be chained together. * * @param hashKey * a map entry including the name and value of the primary hash key. * @param rangeKey * a map entry including the name and value of the primary range key, or null if it is a hash-only table. */ public ScanRequest withExclusiveStartKey(java.util.Map.Entry hashKey, java.util.Map.Entry rangeKey) throws IllegalArgumentException { setExclusiveStartKey(hashKey, rangeKey); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTableName() != null) sb.append("TableName: ").append(getTableName()).append(","); if (getIndexName() != null) sb.append("IndexName: ").append(getIndexName()).append(","); if (getAttributesToGet() != null) sb.append("AttributesToGet: ").append(getAttributesToGet()).append(","); if (getLimit() != null) sb.append("Limit: ").append(getLimit()).append(","); if (getSelect() != null) sb.append("Select: ").append(getSelect()).append(","); if (getScanFilter() != null) sb.append("ScanFilter: ").append(getScanFilter()).append(","); if (getConditionalOperator() != null) sb.append("ConditionalOperator: ").append(getConditionalOperator()).append(","); if (getExclusiveStartKey() != null) sb.append("ExclusiveStartKey: ").append(getExclusiveStartKey()).append(","); if (getReturnConsumedCapacity() != null) sb.append("ReturnConsumedCapacity: ").append(getReturnConsumedCapacity()).append(","); if (getTotalSegments() != null) sb.append("TotalSegments: ").append(getTotalSegments()).append(","); if (getSegment() != null) sb.append("Segment: ").append(getSegment()).append(","); if (getProjectionExpression() != null) sb.append("ProjectionExpression: ").append(getProjectionExpression()).append(","); if (getFilterExpression() != null) sb.append("FilterExpression: ").append(getFilterExpression()).append(","); if (getExpressionAttributeNames() != null) sb.append("ExpressionAttributeNames: ").append(getExpressionAttributeNames()).append(","); if (getExpressionAttributeValues() != null) sb.append("ExpressionAttributeValues: ").append(getExpressionAttributeValues()).append(","); if (getConsistentRead() != null) sb.append("ConsistentRead: ").append(getConsistentRead()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ScanRequest == false) return false; ScanRequest other = (ScanRequest) obj; if (other.getTableName() == null ^ this.getTableName() == null) return false; if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false; if (other.getIndexName() == null ^ this.getIndexName() == null) return false; if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == false) return false; if (other.getAttributesToGet() == null ^ this.getAttributesToGet() == null) return false; if (other.getAttributesToGet() != null && other.getAttributesToGet().equals(this.getAttributesToGet()) == false) return false; if (other.getLimit() == null ^ this.getLimit() == null) return false; if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false) return false; if (other.getSelect() == null ^ this.getSelect() == null) return false; if (other.getSelect() != null && other.getSelect().equals(this.getSelect()) == false) return false; if (other.getScanFilter() == null ^ this.getScanFilter() == null) return false; if (other.getScanFilter() != null && other.getScanFilter().equals(this.getScanFilter()) == false) return false; if (other.getConditionalOperator() == null ^ this.getConditionalOperator() == null) return false; if (other.getConditionalOperator() != null && other.getConditionalOperator().equals(this.getConditionalOperator()) == false) return false; if (other.getExclusiveStartKey() == null ^ this.getExclusiveStartKey() == null) return false; if (other.getExclusiveStartKey() != null && other.getExclusiveStartKey().equals(this.getExclusiveStartKey()) == false) return false; if (other.getReturnConsumedCapacity() == null ^ this.getReturnConsumedCapacity() == null) return false; if (other.getReturnConsumedCapacity() != null && other.getReturnConsumedCapacity().equals(this.getReturnConsumedCapacity()) == false) return false; if (other.getTotalSegments() == null ^ this.getTotalSegments() == null) return false; if (other.getTotalSegments() != null && other.getTotalSegments().equals(this.getTotalSegments()) == false) return false; if (other.getSegment() == null ^ this.getSegment() == null) return false; if (other.getSegment() != null && other.getSegment().equals(this.getSegment()) == false) return false; if (other.getProjectionExpression() == null ^ this.getProjectionExpression() == null) return false; if (other.getProjectionExpression() != null && other.getProjectionExpression().equals(this.getProjectionExpression()) == false) return false; if (other.getFilterExpression() == null ^ this.getFilterExpression() == null) return false; if (other.getFilterExpression() != null && other.getFilterExpression().equals(this.getFilterExpression()) == false) return false; if (other.getExpressionAttributeNames() == null ^ this.getExpressionAttributeNames() == null) return false; if (other.getExpressionAttributeNames() != null && other.getExpressionAttributeNames().equals(this.getExpressionAttributeNames()) == false) return false; if (other.getExpressionAttributeValues() == null ^ this.getExpressionAttributeValues() == null) return false; if (other.getExpressionAttributeValues() != null && other.getExpressionAttributeValues().equals(this.getExpressionAttributeValues()) == false) return false; if (other.getConsistentRead() == null ^ this.getConsistentRead() == null) return false; if (other.getConsistentRead() != null && other.getConsistentRead().equals(this.getConsistentRead()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode()); hashCode = prime * hashCode + ((getIndexName() == null) ? 0 : getIndexName().hashCode()); hashCode = prime * hashCode + ((getAttributesToGet() == null) ? 0 : getAttributesToGet().hashCode()); hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode()); hashCode = prime * hashCode + ((getSelect() == null) ? 0 : getSelect().hashCode()); hashCode = prime * hashCode + ((getScanFilter() == null) ? 0 : getScanFilter().hashCode()); hashCode = prime * hashCode + ((getConditionalOperator() == null) ? 0 : getConditionalOperator().hashCode()); hashCode = prime * hashCode + ((getExclusiveStartKey() == null) ? 0 : getExclusiveStartKey().hashCode()); hashCode = prime * hashCode + ((getReturnConsumedCapacity() == null) ? 0 : getReturnConsumedCapacity().hashCode()); hashCode = prime * hashCode + ((getTotalSegments() == null) ? 0 : getTotalSegments().hashCode()); hashCode = prime * hashCode + ((getSegment() == null) ? 0 : getSegment().hashCode()); hashCode = prime * hashCode + ((getProjectionExpression() == null) ? 0 : getProjectionExpression().hashCode()); hashCode = prime * hashCode + ((getFilterExpression() == null) ? 0 : getFilterExpression().hashCode()); hashCode = prime * hashCode + ((getExpressionAttributeNames() == null) ? 0 : getExpressionAttributeNames().hashCode()); hashCode = prime * hashCode + ((getExpressionAttributeValues() == null) ? 0 : getExpressionAttributeValues().hashCode()); hashCode = prime * hashCode + ((getConsistentRead() == null) ? 0 : getConsistentRead().hashCode()); return hashCode; } @Override public ScanRequest clone() { return (ScanRequest) super.clone(); } }