Class ScanEnhancedRequest
- java.lang.Object
-
- software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest
-
@ThreadSafe public final class ScanEnhancedRequest extends Object
Defines parameters used to when scanning a DynamoDb table or index using the scan() operation (such asDynamoDbTable.scan(ScanEnhancedRequest)).All parameters are optional.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classScanEnhancedRequest.BuilderA builder that is used to create a request with the desired parameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>attributesToProject()/** Returns the list of projected attributes on this request object, or an null if no projection is specified.static ScanEnhancedRequest.Builderbuilder()Creates a newly initialized builder for a request object.BooleanconsistentRead()Returns the value of consistent read, or false if it has not been set.booleanequals(Object o)Map<String,AttributeValue>exclusiveStartKey()Returns the value of the exclusive start key set on this request object, or null if it doesn't exist.ExpressionfilterExpression()Returns the return result filterExpressionset on this request object, or null if it doesn't exist.inthashCode()Integerlimit()Returns the value of limit set on this request object, or null if it doesn't exist.List<NestedAttributeName>nestedAttributesToProject()Returns the list of projected attribute names, in the form ofNestedAttributeNameobjects, for this request object, or null if no projection is specified.ReturnConsumedCapacityreturnConsumedCapacity()Whether to return the capacity consumed by this operation.StringreturnConsumedCapacityAsString()Whether to return the capacity consumed by this operation.Integersegment()Returns the value of segment set on this request object, or null if it doesn't exist.Selectselect()Returns the value of select, or null if it doesn't exist.StringselectAsString()Returns the value of select as a string, or null if it doesn't exist.ScanEnhancedRequest.BuildertoBuilder()Returns a builder initialized with all existing values on the request object.IntegertotalSegments()Returns the value of totalSegments set on this request object, or null if it doesn't exist.
-
-
-
Method Detail
-
builder
public static ScanEnhancedRequest.Builder builder()
Creates a newly initialized builder for a request object.
-
toBuilder
public ScanEnhancedRequest.Builder toBuilder()
Returns a builder initialized with all existing values on the request object.
-
exclusiveStartKey
public Map<String,AttributeValue> exclusiveStartKey()
Returns the value of the exclusive start key set on this request object, or null if it doesn't exist.
-
limit
public Integer limit()
Returns the value of limit set on this request object, or null if it doesn't exist.
-
segment
public Integer segment()
Returns the value of segment set on this request object, or null if it doesn't exist.
-
totalSegments
public Integer totalSegments()
Returns the value of totalSegments set on this request object, or null if it doesn't exist.
-
consistentRead
public Boolean consistentRead()
Returns the value of consistent read, or false if it has not been set.
-
filterExpression
public Expression filterExpression()
Returns the return result filterExpressionset on this request object, or null if it doesn't exist.
-
select
public Select select()
Returns the value of select, or null if it doesn't exist.- Returns:
-
selectAsString
public String selectAsString()
Returns the value of select as a string, or null if it doesn't exist.- Returns:
-
attributesToProject
public List<String> attributesToProject()
/** Returns the list of projected attributes on this request object, or an null if no projection is specified. Nested attributes are represented using the '.' separator. Example : foo.bar is represented as "foo.bar" which is indistinguishable from a non-nested attribute with the name "foo.bar". UsenestedAttributesToProject()if you have a use-case that requires discrimination between these two cases.
-
nestedAttributesToProject
public List<NestedAttributeName> nestedAttributesToProject()
Returns the list of projected attribute names, in the form ofNestedAttributeNameobjects, for this request object, or null if no projection is specified. ReferNestedAttributeName
-
returnConsumedCapacity
public ReturnConsumedCapacity returnConsumedCapacity()
Whether to return the capacity consumed by this operation.- See Also:
ScanRequest.returnConsumedCapacity()
-
returnConsumedCapacityAsString
public String returnConsumedCapacityAsString()
Whether to return the capacity consumed by this operation.Similar to
returnConsumedCapacity()but return the value as a string. This is useful in situations where the value is not defined inReturnConsumedCapacity.
-
-