Class QueryEnhancedRequest
java.lang.Object
software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest
Defines parameters used to when querying a DynamoDb table or index using the query() operation (such as
DynamoDbTable.query(QueryEnhancedRequest)
or DynamoDbAsyncIndex.query(QueryEnhancedRequest)
).
A valid request object must contain a QueryConditional
condition specifying how DynamoDb
should match items in the table.
All other parameters are optional.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A builder that is used to create a request with the desired parameters. -
Method Summary
Modifier and TypeMethodDescriptionReturns the list of projected attributes on this request object, or an null if no projection is specified.static QueryEnhancedRequest.Builder
builder()
Creates a newly initialized builder for a request object.Returns the value of consistent read, or false if it has not been set.boolean
Returns the value of the exclusive start key set on this request object, or null if it doesn't exist.Returns the return result filterExpression
set on this request object, or null if it doesn't exist.int
hashCode()
limit()
Returns the value of limit set on this request object, or null if it doesn't exist.Returns the list of projected attribute names, in the form ofNestedAttributeName
objects, for this request object, or null if no projection is specified.Returns the matching condition of the query.Whether to return the capacity consumed by this operation.Whether to return the capacity consumed by this operation.Returns the value of scan index forward, meaning an ascending result sort order, or true if it has not been set.Returns a builder initialized with all existing values on the request object.
-
Method Details
-
builder
Creates a newly initialized builder for a request object. -
toBuilder
Returns a builder initialized with all existing values on the request object. -
queryConditional
Returns the matching condition of the query. -
exclusiveStartKey
Returns the value of the exclusive start key set on this request object, or null if it doesn't exist. -
scanIndexForward
Returns the value of scan index forward, meaning an ascending result sort order, or true if it has not been set. -
limit
Returns the value of limit set on this request object, or null if it doesn't exist. -
consistentRead
Returns the value of consistent read, or false if it has not been set. -
filterExpression
Returns the return result filterExpression
set on this request object, or null if it doesn't exist. -
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
Returns the list of projected attribute names, in the form ofNestedAttributeName
objects, for this request object, or null if no projection is specified. ReferNestedAttributeName
. -
returnConsumedCapacity
Whether to return the capacity consumed by this operation.- See Also:
-
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
. -
equals
-
hashCode
public int hashCode()
-