com.amazonaws.services.dynamodbv2.model.ScanRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2010-2016 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;
/**
*
* Represents the input of a Scan operation.
*
*/
public class ScanRequest extends 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, for backward compatibility. New applications
* should use ProjectionExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or Map;
* however, it cannot retrieve individual elements within a List or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute names
* are provided, then all attributes will be returned. If any of the
* requested attributes are not found, they will not appear in the result.
*
*
* Note that AttributesToGet has no effect on provisioned throughput
* consumption. DynamoDB determines capacity units consumed based on item
* size, not on the amount of data that is returned to an application.
*
*/
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.
*
*/
private Integer limit;
/**
*
* The attributes to be returned in the result. You can retrieve all item
* attributes, specific item attributes, or the count of matching items.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an
* index. Retrieves all attributes that have been projected into the index.
* If the index is configured to project all attributes, this return value
* is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both
* AttributesToGet and Select together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without
* any value for Select.)
*
*/
private String select;
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A condition that evaluates the scan results and returns only the desired
* values.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* If you specify more than one condition in the ScanFilter map, then
* by default all of the conditions must evaluate to true. In other words,
* the conditions are ANDed together. (You can use the
* ConditionalOperator parameter to OR the conditions instead. If you
* do this, then at least one of the conditions must evaluate to true,
* rather than all of them.)
*
*
* Each ScanFilter element consists of an attribute name to compare,
* along with the following:
*
*
* -
*
* AttributeValueList - One or more values to evaluate against the
* supplied attribute. The number of values in the list depends on the
* operator specified in ComparisonOperator .
*
*
* For type Number, value comparisons are numeric.
*
*
* String value comparisons for greater than, equals, or less than are based
* on ASCII character code values. For example, a is greater
* than A, and a is greater than B.
* For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
*
*
* For Binary, DynamoDB treats each byte of the binary data as unsigned when
* it compares binary values.
*
*
* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* ComparisonOperator - A comparator for evaluating attributes. For
* example, equals, greater than, less than, etc.
*
*
* The following comparison operators are available:
*
*
* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
*
*
* For complete descriptions of all comparison operators, see Condition.
*
*
*
*/
private java.util.Map scanFilter;
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then the
* entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to true,
* then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is the
* default.
*
*
* The operation will succeed only if the entire map evaluates to true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*/
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 Accessing Item Attributes in the Amazon DynamoDB Developer
* Guide.
*
*
*
* ProjectionExpression replaces the legacy AttributesToGet
* parameter.
*
*
*/
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.
*
*
*
* FilterExpression replaces the legacy ScanFilter and
* ConditionalOperator parameters.
*
*
*/
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 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, for backward compatibility. New applications
* should use ProjectionExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or Map;
* however, it cannot retrieve individual elements within a List or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute names
* are provided, then all attributes will be returned. If any of the
* requested attributes are not found, they will not appear in the result.
*
*
* Note that AttributesToGet has no effect on provisioned throughput
* consumption. DynamoDB determines capacity units consumed based on item
* size, not on the amount of data that is returned to an application.
*
*
* @return
* This is a legacy parameter, for backward compatibility. New
* applications should use ProjectionExpression instead. Do
* not combine legacy parameters and expression parameters in a
* single API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or
* Map; however, it cannot retrieve individual elements within a
* List or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute
* names are provided, then all attributes will be returned. If any
* of the requested attributes are not found, they will not appear
* in the result.
*
*
* Note that AttributesToGet has no effect on provisioned
* throughput consumption. DynamoDB determines capacity units
* consumed based on item size, not on the amount of data that is
* returned to an application.
*/
public java.util.List getAttributesToGet() {
return attributesToGet;
}
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use ProjectionExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or Map;
* however, it cannot retrieve individual elements within a List or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute names
* are provided, then all attributes will be returned. If any of the
* requested attributes are not found, they will not appear in the result.
*
*
* Note that AttributesToGet has no effect on provisioned throughput
* consumption. DynamoDB determines capacity units consumed based on item
* size, not on the amount of data that is returned to an application.
*
*
* @param attributesToGet
*
* This is a legacy parameter, for backward compatibility. New
* applications should use ProjectionExpression instead. Do
* not combine legacy parameters and expression parameters in a
* single API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or
* Map; however, it cannot retrieve individual elements within a List
* or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute
* names are provided, then all attributes will be returned. If any
* of the requested attributes are not found, they will not appear in
* the result.
*
*
* Note that AttributesToGet has no effect on provisioned
* throughput consumption. DynamoDB determines capacity units
* consumed based on item size, not on the amount of data that is
* returned to an application.
*/
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, for backward compatibility. New applications
* should use ProjectionExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or Map;
* however, it cannot retrieve individual elements within a List or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute names
* are provided, then all attributes will be returned. If any of the
* requested attributes are not found, they will not appear in the result.
*
*
* Note that AttributesToGet has no effect on provisioned throughput
* consumption. DynamoDB determines capacity units consumed based on item
* size, not on the amount of data that is returned to an application.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@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, for backward compatibility. New
* applications should use ProjectionExpression instead. Do
* not combine legacy parameters and expression parameters in a
* single API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or
* Map; however, it cannot retrieve individual elements within a List
* or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute
* names are provided, then all attributes will be returned. If any
* of the requested attributes are not found, they will not appear in
* the result.
*
*
* Note that AttributesToGet has no effect on provisioned
* throughput consumption. DynamoDB determines capacity units
* consumed based on item size, not on the amount of data that is
* returned to an application.
* @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, for backward compatibility. New applications
* should use ProjectionExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or Map;
* however, it cannot retrieve individual elements within a List or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute names
* are provided, then all attributes will be returned. If any of the
* requested attributes are not found, they will not appear in the result.
*
*
* Note that AttributesToGet has no effect on provisioned throughput
* consumption. DynamoDB determines capacity units consumed based on item
* size, not on the amount of data that is returned to an application.
*
*
* @param attributesToGet
*
* This is a legacy parameter, for backward compatibility. New
* applications should use ProjectionExpression instead. Do
* not combine legacy parameters and expression parameters in a
* single API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
* This parameter allows you to retrieve attributes of type List or
* Map; however, it cannot retrieve individual elements within a List
* or a Map.
*
*
*
* The names of one or more attributes to retrieve. If no attribute
* names are provided, then all attributes will be returned. If any
* of the requested attributes are not found, they will not appear in
* the result.
*
*
* Note that AttributesToGet has no effect on provisioned
* throughput consumption. DynamoDB determines capacity units
* consumed based on item size, not on the amount of data that is
* returned to an application.
* @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;
}
/**
*
* 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.
*
*
* @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;
}
/**
*
* 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 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 this.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.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public ScanRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* The attributes to be returned in the result. You can retrieve all item
* attributes, specific item attributes, or the count of matching items.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an
* index. Retrieves all attributes that have been projected into the index.
* If the index is configured to project all attributes, this return value
* is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both
* AttributesToGet and Select together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without
* any value for Select.)
*
*
* @param select
* The attributes to be returned in the result. You can retrieve all
* item attributes, specific item attributes, or the count of
* matching items.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying
* an index. Retrieves all attributes that have been projected into
* the index. If the index is configured to project all attributes,
* this return value is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use
* both AttributesToGet and Select together in a single
* request, unless the value for Select is
* SPECIFIC_ATTRIBUTES. (This usage is equivalent to
* specifying AttributesToGet without any value for
* Select.)
* @see Select
*/
public void setSelect(String select) {
this.select = select;
}
/**
*
* The attributes to be returned in the result. You can retrieve all item
* attributes, specific item attributes, or the count of matching items.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an
* index. Retrieves all attributes that have been projected into the index.
* If the index is configured to project all attributes, this return value
* is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both
* AttributesToGet and Select together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without
* any value for Select.)
*
*
* @return The attributes to be returned in the result. You can retrieve all
* item attributes, specific item attributes, or the count of
* matching items.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when
* querying an index. Retrieves all attributes that have been
* projected into the index. If the index is configured to project
* all attributes, this return value is equivalent to 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 neither Select nor AttributesToGet are
* specified, DynamoDB defaults to ALL_ATTRIBUTES. You
* cannot use both AttributesToGet and Select together
* in a single request, unless the value for Select is
* SPECIFIC_ATTRIBUTES. (This usage is equivalent to
* specifying AttributesToGet without any value for
* Select.)
* @see Select
*/
public String getSelect() {
return this.select;
}
/**
*
* The attributes to be returned in the result. You can retrieve all item
* attributes, specific item attributes, or the count of matching items.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an
* index. Retrieves all attributes that have been projected into the index.
* If the index is configured to project all attributes, this return value
* is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both
* AttributesToGet and Select together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without
* any value for Select.)
*
*
* @param select
* The attributes to be returned in the result. You can retrieve all
* item attributes, specific item attributes, or the count of
* matching items.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying
* an index. Retrieves all attributes that have been projected into
* the index. If the index is configured to project all attributes,
* this return value is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use
* both AttributesToGet and Select together in a single
* request, unless the value for Select is
* SPECIFIC_ATTRIBUTES. (This usage is equivalent to
* specifying AttributesToGet without any value for
* Select.)
* @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;
}
/**
*
* The attributes to be returned in the result. You can retrieve all item
* attributes, specific item attributes, or the count of matching items.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an
* index. Retrieves all attributes that have been projected into the index.
* If the index is configured to project all attributes, this return value
* is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both
* AttributesToGet and Select together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without
* any value for Select.)
*
*
* @param select
* The attributes to be returned in the result. You can retrieve all
* item attributes, specific item attributes, or the count of
* matching items.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying
* an index. Retrieves all attributes that have been projected into
* the index. If the index is configured to project all attributes,
* this return value is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use
* both AttributesToGet and Select together in a single
* request, unless the value for Select is
* SPECIFIC_ATTRIBUTES. (This usage is equivalent to
* specifying AttributesToGet without any value for
* Select.)
* @see Select
*/
public void setSelect(Select select) {
this.select = select.toString();
}
/**
*
* The attributes to be returned in the result. You can retrieve all item
* attributes, specific item attributes, or the count of matching items.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an
* index. Retrieves all attributes that have been projected into the index.
* If the index is configured to project all attributes, this return value
* is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both
* AttributesToGet and Select together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without
* any value for Select.)
*
*
* @param select
* The attributes to be returned in the result. You can retrieve all
* item attributes, specific item attributes, or the count of
* matching items.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying
* an index. Retrieves all attributes that have been projected into
* the index. If the index is configured to project all attributes,
* this return value is equivalent to 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 neither Select nor AttributesToGet are specified,
* DynamoDB defaults to ALL_ATTRIBUTES. You cannot use
* both AttributesToGet and Select together in a single
* request, unless the value for Select is
* SPECIFIC_ATTRIBUTES. (This usage is equivalent to
* specifying AttributesToGet without any value for
* Select.)
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see Select
*/
public ScanRequest withSelect(Select select) {
setSelect(select);
return this;
}
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A condition that evaluates the scan results and returns only the desired
* values.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* If you specify more than one condition in the ScanFilter map, then
* by default all of the conditions must evaluate to true. In other words,
* the conditions are ANDed together. (You can use the
* ConditionalOperator parameter to OR the conditions instead. If you
* do this, then at least one of the conditions must evaluate to true,
* rather than all of them.)
*
*
* Each ScanFilter element consists of an attribute name to compare,
* along with the following:
*
*
* -
*
* AttributeValueList - One or more values to evaluate against the
* supplied attribute. The number of values in the list depends on the
* operator specified in ComparisonOperator .
*
*
* For type Number, value comparisons are numeric.
*
*
* String value comparisons for greater than, equals, or less than are based
* on ASCII character code values. For example, a is greater
* than A, and a is greater than B.
* For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
*
*
* For Binary, DynamoDB treats each byte of the binary data as unsigned when
* it compares binary values.
*
*
* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* ComparisonOperator - A comparator for evaluating attributes. For
* example, equals, greater than, less than, etc.
*
*
* The following comparison operators are available:
*
*
* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
*
*
* For complete descriptions of all comparison operators, see Condition.
*
*
*
*
* @return
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A condition that evaluates the scan results and returns only the
* desired values.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* If you specify more than one condition in the ScanFilter
* map, then by default all of the conditions must evaluate to true.
* In other words, the conditions are ANDed together. (You can use
* the ConditionalOperator parameter to OR the conditions
* instead. If you do this, then at least one of the conditions must
* evaluate to true, rather than all of them.)
*
*
* Each ScanFilter element consists of an attribute name to
* compare, along with the following:
*
*
* -
*
* AttributeValueList - One or more values to evaluate
* against the supplied attribute. The number of values in the list
* depends on the operator specified in ComparisonOperator .
*
*
* For type Number, value comparisons are numeric.
*
*
* String value comparisons for greater than, equals, or less than
* are based on ASCII character code values. For example,
* a is greater than A, and a
* is greater than B. For a list of code values, see http
* ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
*
*
* For Binary, DynamoDB treats each byte of the binary data as
* unsigned when it compares binary values.
*
*
* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer
* Guide.
*
*
* -
*
* ComparisonOperator - A comparator for evaluating
* attributes. For example, equals, greater than, less than, etc.
*
*
* The following comparison operators are available:
*
*
* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
*
*
* For complete descriptions of all comparison operators, see Condition.
*
*
*/
public java.util.Map getScanFilter() {
return scanFilter;
}
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A condition that evaluates the scan results and returns only the desired
* values.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* If you specify more than one condition in the ScanFilter map, then
* by default all of the conditions must evaluate to true. In other words,
* the conditions are ANDed together. (You can use the
* ConditionalOperator parameter to OR the conditions instead. If you
* do this, then at least one of the conditions must evaluate to true,
* rather than all of them.)
*
*
* Each ScanFilter element consists of an attribute name to compare,
* along with the following:
*
*
* -
*
* AttributeValueList - One or more values to evaluate against the
* supplied attribute. The number of values in the list depends on the
* operator specified in ComparisonOperator .
*
*
* For type Number, value comparisons are numeric.
*
*
* String value comparisons for greater than, equals, or less than are based
* on ASCII character code values. For example, a is greater
* than A, and a is greater than B.
* For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
*
*
* For Binary, DynamoDB treats each byte of the binary data as unsigned when
* it compares binary values.
*
*
* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* ComparisonOperator - A comparator for evaluating attributes. For
* example, equals, greater than, less than, etc.
*
*
* The following comparison operators are available:
*
*
* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
*
*
* For complete descriptions of all comparison operators, see Condition.
*
*
*
*
* @param scanFilter
*
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A condition that evaluates the scan results and returns only the
* desired values.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* If you specify more than one condition in the ScanFilter
* map, then by default all of the conditions must evaluate to true.
* In other words, the conditions are ANDed together. (You can use
* the ConditionalOperator parameter to OR the conditions
* instead. If you do this, then at least one of the conditions must
* evaluate to true, rather than all of them.)
*
*
* Each ScanFilter element consists of an attribute name to
* compare, along with the following:
*
*
* -
*
* AttributeValueList - One or more values to evaluate against
* the supplied attribute. The number of values in the list depends
* on the operator specified in ComparisonOperator .
*
*
* For type Number, value comparisons are numeric.
*
*
* String value comparisons for greater than, equals, or less than
* are based on ASCII character code values. For example,
* a is greater than A, and a
* is greater than B. For a list of code values, see http
* ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
*
*
* For Binary, DynamoDB treats each byte of the binary data as
* unsigned when it compares binary values.
*
*
* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer
* Guide.
*
*
* -
*
* ComparisonOperator - A comparator for evaluating
* attributes. For example, equals, greater than, less than, etc.
*
*
* The following comparison operators are available:
*
*
* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
*
*
* For complete descriptions of all comparison operators, see Condition.
*
*
*/
public void setScanFilter(java.util.Map scanFilter) {
this.scanFilter = scanFilter;
}
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A condition that evaluates the scan results and returns only the desired
* values.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* If you specify more than one condition in the ScanFilter map, then
* by default all of the conditions must evaluate to true. In other words,
* the conditions are ANDed together. (You can use the
* ConditionalOperator parameter to OR the conditions instead. If you
* do this, then at least one of the conditions must evaluate to true,
* rather than all of them.)
*
*
* Each ScanFilter element consists of an attribute name to compare,
* along with the following:
*
*
* -
*
* AttributeValueList - One or more values to evaluate against the
* supplied attribute. The number of values in the list depends on the
* operator specified in ComparisonOperator .
*
*
* For type Number, value comparisons are numeric.
*
*
* String value comparisons for greater than, equals, or less than are based
* on ASCII character code values. For example, a is greater
* than A, and a is greater than B.
* For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
*
*
* For Binary, DynamoDB treats each byte of the binary data as unsigned when
* it compares binary values.
*
*
* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* ComparisonOperator - A comparator for evaluating attributes. For
* example, equals, greater than, less than, etc.
*
*
* The following comparison operators are available:
*
*
* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
*
*
* For complete descriptions of all comparison operators, see Condition.
*
*
*
*
* @param scanFilter
*
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A condition that evaluates the scan results and returns only the
* desired values.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* If you specify more than one condition in the ScanFilter
* map, then by default all of the conditions must evaluate to true.
* In other words, the conditions are ANDed together. (You can use
* the ConditionalOperator parameter to OR the conditions
* instead. If you do this, then at least one of the conditions must
* evaluate to true, rather than all of them.)
*
*
* Each ScanFilter element consists of an attribute name to
* compare, along with the following:
*
*
* -
*
* AttributeValueList - One or more values to evaluate against
* the supplied attribute. The number of values in the list depends
* on the operator specified in ComparisonOperator .
*
*
* For type Number, value comparisons are numeric.
*
*
* String value comparisons for greater than, equals, or less than
* are based on ASCII character code values. For example,
* a is greater than A, and a
* is greater than B. For a list of code values, see http
* ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
*
*
* For Binary, DynamoDB treats each byte of the binary data as
* unsigned when it compares binary values.
*
*
* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer
* Guide.
*
*
* -
*
* ComparisonOperator - A comparator for evaluating
* attributes. For example, equals, greater than, less than, etc.
*
*
* The following comparison operators are available:
*
*
* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
*
*
* For complete descriptions of all comparison operators, see Condition.
*
*
* @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;
}
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. <p> 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, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then the
* entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to true,
* then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is the
* default.
*
*
* The operation will succeed only if the entire map evaluates to true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* @param conditionalOperator
*
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a
* ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then
* the entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to
* true, then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is
* the default.
*
*
* The operation will succeed only if the entire map evaluates to
* true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
* @see ConditionalOperator
*/
public void setConditionalOperator(String conditionalOperator) {
this.conditionalOperator = conditionalOperator;
}
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then the
* entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to true,
* then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is the
* default.
*
*
* The operation will succeed only if the entire map evaluates to true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* @return
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a
* ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true,
* then the entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to
* true, then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is
* the default.
*
*
* The operation will succeed only if the entire map evaluates to
* true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
* @see ConditionalOperator
*/
public String getConditionalOperator() {
return this.conditionalOperator;
}
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then the
* entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to true,
* then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is the
* default.
*
*
* The operation will succeed only if the entire map evaluates to true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* @param conditionalOperator
*
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a
* ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then
* the entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to
* true, then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is
* the default.
*
*
* The operation will succeed only if the entire map evaluates to
* true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
* @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, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then the
* entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to true,
* then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is the
* default.
*
*
* The operation will succeed only if the entire map evaluates to true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* @param conditionalOperator
*
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a
* ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then
* the entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to
* true, then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is
* the default.
*
*
* The operation will succeed only if the entire map evaluates to
* true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
* @see ConditionalOperator
*/
public void setConditionalOperator(ConditionalOperator conditionalOperator) {
this.conditionalOperator = conditionalOperator.toString();
}
/**
*
*
* This is a legacy parameter, for backward compatibility. New applications
* should use FilterExpression instead. Do not combine legacy
* parameters and expression parameters in a single API call; otherwise,
* DynamoDB will return a ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then the
* entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to true,
* then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is the
* default.
*
*
* The operation will succeed only if the entire map evaluates to true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
*
*
* @param conditionalOperator
*
* This is a legacy parameter, for backward compatibility. New
* applications should use FilterExpression instead. Do not
* combine legacy parameters and expression parameters in a single
* API call; otherwise, DynamoDB will return a
* ValidationException exception.
*
*
*
* A logical operator to apply to the conditions in a
* ScanFilter map:
*
*
* -
*
* AND - If all of the conditions evaluate to true, then
* the entire map evaluates to true.
*
*
* -
*
* OR - If at least one of the conditions evaluate to
* true, then the entire map evaluates to true.
*
*
*
*
* If you omit ConditionalOperator, then AND is
* the default.
*
*
* The operation will succeed only if the entire map evaluates to
* true.
*
*
*
* This parameter does not support attributes of type List or Map.
*
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see ConditionalOperator
*/
public ScanRequest withConditionalOperator(
ConditionalOperator conditionalOperator) {
setConditionalOperator(conditionalOperator);
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.
*
*
* @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;
}
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. <p> 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) {
this.returnConsumedCapacity = returnConsumedCapacity.toString();
}
/**
* @param returnConsumedCapacity
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see ReturnConsumedCapacity
*/
public ScanRequest withReturnConsumedCapacity(
ReturnConsumedCapacity returnConsumedCapacity) {
setReturnConsumedCapacity(returnConsumedCapacity);
return this;
}
/**
*
* 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.
*
*
* @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;
}
/**
*
* 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.
*
*
* @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 this.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.
*
*
* @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.
* @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.
*
*
* 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.
*
*
* @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.
*
*
* 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.
*
*
* @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 this.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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ScanRequest withSegment(Integer segment) {
setSegment(segment);
return this;
}
/**
*
* A string that identifies one or more attributes to retrieve from the
* specified table or index. These attributes can include scalars, sets, or
* elements of a JSON document. The attributes in the expression must be
* separated by commas.
*
*
* If no attribute names are specified, then all attributes will be
* returned. If any of the requested attributes are not found, they will not
* appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer
* Guide.
*
*
*
* ProjectionExpression replaces the legacy AttributesToGet
* parameter.
*
*
*
* @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 Accessing Item Attributes in the Amazon DynamoDB Developer
* Guide.
*
*
*
* ProjectionExpression replaces the legacy
* AttributesToGet parameter.
*
*/
public void setProjectionExpression(String projectionExpression) {
this.projectionExpression = projectionExpression;
}
/**
*
* A string that identifies one or more attributes to retrieve from the
* specified table or index. These attributes can include scalars, sets, or
* elements of a JSON document. The attributes in the expression must be
* separated by commas.
*
*
* If no attribute names are specified, then all attributes will be
* returned. If any of the requested attributes are not found, they will not
* appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer
* Guide.
*
*
*
* ProjectionExpression replaces the legacy AttributesToGet
* parameter.
*
*
*
* @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 Accessing Item Attributes in the Amazon DynamoDB
* Developer Guide.
*
*
*
* ProjectionExpression replaces the legacy
* AttributesToGet parameter.
*
*/
public String getProjectionExpression() {
return this.projectionExpression;
}
/**
*
* A string that identifies one or more attributes to retrieve from the
* specified table or index. These attributes can include scalars, sets, or
* elements of a JSON document. The attributes in the expression must be
* separated by commas.
*
*
* If no attribute names are specified, then all attributes will be
* returned. If any of the requested attributes are not found, they will not
* appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer
* Guide.
*
*
*
* ProjectionExpression replaces the legacy AttributesToGet
* parameter.
*
*
*
* @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 Accessing Item Attributes in the Amazon DynamoDB Developer
* Guide.
*
*
*
* ProjectionExpression replaces the legacy
* AttributesToGet parameter.
*
* @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 string that contains conditions that DynamoDB applies after the
* Scan operation, but before the data is returned to you. Items that
* do not satisfy the FilterExpression criteria are not returned.
*
*
*
* A FilterExpression is applied after the items have already been
* read; the process of filtering does not consume any additional read
* capacity units.
*
*
*
* For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
*
*
*
* FilterExpression replaces the legacy ScanFilter and
* ConditionalOperator parameters.
*
*
*
* @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.
*
*
*
* FilterExpression replaces the legacy ScanFilter and
* ConditionalOperator parameters.
*
*/
public void setFilterExpression(String filterExpression) {
this.filterExpression = filterExpression;
}
/**
*
* A string that contains conditions that DynamoDB applies after the
* Scan operation, but before the data is returned to you. Items that
* do not satisfy the FilterExpression criteria are not returned.
*
*
*
* A FilterExpression is applied after the items have already been
* read; the process of filtering does not consume any additional read
* capacity units.
*
*
*
* For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
*
*
*
* FilterExpression replaces the legacy ScanFilter and
* ConditionalOperator parameters.
*
*
*
* @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.
*
*
*
* FilterExpression replaces the legacy ScanFilter and
* ConditionalOperator parameters.
*
*/
public String getFilterExpression() {
return this.filterExpression;
}
/**
*
* A string that contains conditions that DynamoDB applies after the
* Scan operation, but before the data is returned to you. Items that
* do not satisfy the FilterExpression criteria are not returned.
*
*
*
* A FilterExpression is applied after the items have already been
* read; the process of filtering does not consume any additional read
* capacity units.
*
*
*
* For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
*
*
*
* FilterExpression replaces the legacy ScanFilter and
* ConditionalOperator parameters.
*
*
*
* @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.
*
*
*
* FilterExpression replaces the legacy ScanFilter and
* ConditionalOperator parameters.
*
* @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
*
*
*
*
* 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.
*
*
* @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 Accessing 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
*
*
*
*
* 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.
*
*
* @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 Accessing 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
*
*
*
*
* 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.
*
*
* @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 Accessing 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;
}
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. <p>
* 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.
*
*
* 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.
*
*
* @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 Specifying Conditions in the Amazon DynamoDB Developer
* Guide.
*/
public java.util.Map getExpressionAttributeValues() {
return expressionAttributeValues;
}
/**
*
* One or more values that can be substituted in an expression.
*
*
* Use the : (colon) character in an expression to dereference an
* attribute value. For example, suppose that you wanted to check whether
* the value of the ProductStatus attribute was one of the following:
*
*
* Available | Backordered | Discontinued
*
*
* You would first need to specify ExpressionAttributeValues as
* follows:
*
*
* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
*
*
* You could then use these values in an expression, such as this:
*
*
* ProductStatus IN (:avail, :back, :disc)
*
*
* For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
*
*
* @param expressionAttributeValues
* One or more values that can be substituted in an expression.
*
* Use the : (colon) character in an expression to dereference
* an attribute value. For example, suppose that you wanted to check
* whether the value of the ProductStatus attribute was one of
* the following:
*
*
* Available | Backordered | Discontinued
*
*
* You would first need to specify ExpressionAttributeValues
* as follows:
*
*
* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
*
*
* You could then use these values in an expression, such as this:
*
*
* ProductStatus IN (:avail, :back, :disc)
*
*
* For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer
* Guide.
*/
public void setExpressionAttributeValues(
java.util.Map expressionAttributeValues) {
this.expressionAttributeValues = expressionAttributeValues;
}
/**
*
* One or more values that can be substituted in an expression.
*
*
* Use the : (colon) character in an expression to dereference an
* attribute value. For example, suppose that you wanted to check whether
* the value of the ProductStatus attribute was one of the following:
*
*
* Available | Backordered | Discontinued
*
*
* You would first need to specify ExpressionAttributeValues as
* follows:
*
*
* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
*
*
* You could then use these values in an expression, such as this:
*
*
* ProductStatus IN (:avail, :back, :disc)
*
*
* For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
*
*
* @param expressionAttributeValues
* One or more values that can be substituted in an expression.
*
* Use the : (colon) character in an expression to dereference
* an attribute value. For example, suppose that you wanted to check
* whether the value of the ProductStatus attribute was one of
* the following:
*
*
* Available | Backordered | Discontinued
*
*
* You would first need to specify ExpressionAttributeValues
* as follows:
*
*
* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
*
*
* You could then use these values in an expression, such as this:
*
*
* ProductStatus IN (:avail, :back, :disc)
*
*
* For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer
* Guide.
* @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;
}
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. <p>
* 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.
*
*
* 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 void setConsistentRead(Boolean consistentRead) {
this.consistentRead = 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 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 getConsistentRead() {
return this.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.
*
*
* @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; useful for testing and
* debugging.
*
* @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: " + getTableName() + ",");
if (getIndexName() != null)
sb.append("IndexName: " + getIndexName() + ",");
if (getAttributesToGet() != null)
sb.append("AttributesToGet: " + getAttributesToGet() + ",");
if (getLimit() != null)
sb.append("Limit: " + getLimit() + ",");
if (getSelect() != null)
sb.append("Select: " + getSelect() + ",");
if (getScanFilter() != null)
sb.append("ScanFilter: " + getScanFilter() + ",");
if (getConditionalOperator() != null)
sb.append("ConditionalOperator: " + getConditionalOperator() + ",");
if (getExclusiveStartKey() != null)
sb.append("ExclusiveStartKey: " + getExclusiveStartKey() + ",");
if (getReturnConsumedCapacity() != null)
sb.append("ReturnConsumedCapacity: " + getReturnConsumedCapacity()
+ ",");
if (getTotalSegments() != null)
sb.append("TotalSegments: " + getTotalSegments() + ",");
if (getSegment() != null)
sb.append("Segment: " + getSegment() + ",");
if (getProjectionExpression() != null)
sb.append("ProjectionExpression: " + getProjectionExpression()
+ ",");
if (getFilterExpression() != null)
sb.append("FilterExpression: " + getFilterExpression() + ",");
if (getExpressionAttributeNames() != null)
sb.append("ExpressionAttributeNames: "
+ getExpressionAttributeNames() + ",");
if (getExpressionAttributeValues() != null)
sb.append("ExpressionAttributeValues: "
+ getExpressionAttributeValues() + ",");
if (getConsistentRead() != null)
sb.append("ConsistentRead: " + 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();
}
}