software.amazon.awssdk.services.dynamodb.model.QueryRequest Maven / Gradle / Ivy
Show all versions of dynamodb Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.dynamodb.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the input of a Query operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class QueryRequest extends DynamoDbRequest implements ToCopyableBuilder {
private static final SdkField TABLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TableName").getter(getter(QueryRequest::tableName)).setter(setter(Builder::tableName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TableName").build()).build();
private static final SdkField INDEX_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IndexName").getter(getter(QueryRequest::indexName)).setter(setter(Builder::indexName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndexName").build()).build();
private static final SdkField SELECT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Select")
.getter(getter(QueryRequest::selectAsString)).setter(setter(Builder::select))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Select").build()).build();
private static final SdkField> ATTRIBUTES_TO_GET_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AttributesToGet")
.getter(getter(QueryRequest::attributesToGet))
.setter(setter(Builder::attributesToGet))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttributesToGet").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Limit")
.getter(getter(QueryRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Limit").build()).build();
private static final SdkField CONSISTENT_READ_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ConsistentRead").getter(getter(QueryRequest::consistentRead)).setter(setter(Builder::consistentRead))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConsistentRead").build()).build();
private static final SdkField> KEY_CONDITIONS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("KeyConditions")
.getter(getter(QueryRequest::keyConditions))
.setter(setter(Builder::keyConditions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyConditions").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Condition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> QUERY_FILTER_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("QueryFilter")
.getter(getter(QueryRequest::queryFilter))
.setter(setter(Builder::queryFilter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QueryFilter").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Condition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField CONDITIONAL_OPERATOR_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConditionalOperator").getter(getter(QueryRequest::conditionalOperatorAsString))
.setter(setter(Builder::conditionalOperator))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConditionalOperator").build())
.build();
private static final SdkField SCAN_INDEX_FORWARD_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ScanIndexForward").getter(getter(QueryRequest::scanIndexForward))
.setter(setter(Builder::scanIndexForward))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScanIndexForward").build()).build();
private static final SdkField> EXCLUSIVE_START_KEY_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("ExclusiveStartKey")
.getter(getter(QueryRequest::exclusiveStartKey))
.setter(setter(Builder::exclusiveStartKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExclusiveStartKey").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField RETURN_CONSUMED_CAPACITY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReturnConsumedCapacity").getter(getter(QueryRequest::returnConsumedCapacityAsString))
.setter(setter(Builder::returnConsumedCapacity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReturnConsumedCapacity").build())
.build();
private static final SdkField PROJECTION_EXPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProjectionExpression").getter(getter(QueryRequest::projectionExpression))
.setter(setter(Builder::projectionExpression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProjectionExpression").build())
.build();
private static final SdkField FILTER_EXPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FilterExpression").getter(getter(QueryRequest::filterExpression))
.setter(setter(Builder::filterExpression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FilterExpression").build()).build();
private static final SdkField KEY_CONDITION_EXPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KeyConditionExpression").getter(getter(QueryRequest::keyConditionExpression))
.setter(setter(Builder::keyConditionExpression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyConditionExpression").build())
.build();
private static final SdkField> EXPRESSION_ATTRIBUTE_NAMES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("ExpressionAttributeNames")
.getter(getter(QueryRequest::expressionAttributeNames))
.setter(setter(Builder::expressionAttributeNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExpressionAttributeNames").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> EXPRESSION_ATTRIBUTE_VALUES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("ExpressionAttributeValues")
.getter(getter(QueryRequest::expressionAttributeValues))
.setter(setter(Builder::expressionAttributeValues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExpressionAttributeValues").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TABLE_NAME_FIELD,
INDEX_NAME_FIELD, SELECT_FIELD, ATTRIBUTES_TO_GET_FIELD, LIMIT_FIELD, CONSISTENT_READ_FIELD, KEY_CONDITIONS_FIELD,
QUERY_FILTER_FIELD, CONDITIONAL_OPERATOR_FIELD, SCAN_INDEX_FORWARD_FIELD, EXCLUSIVE_START_KEY_FIELD,
RETURN_CONSUMED_CAPACITY_FIELD, PROJECTION_EXPRESSION_FIELD, FILTER_EXPRESSION_FIELD, KEY_CONDITION_EXPRESSION_FIELD,
EXPRESSION_ATTRIBUTE_NAMES_FIELD, EXPRESSION_ATTRIBUTE_VALUES_FIELD));
private final String tableName;
private final String indexName;
private final String select;
private final List attributesToGet;
private final Integer limit;
private final Boolean consistentRead;
private final Map keyConditions;
private final Map queryFilter;
private final String conditionalOperator;
private final Boolean scanIndexForward;
private final Map exclusiveStartKey;
private final String returnConsumedCapacity;
private final String projectionExpression;
private final String filterExpression;
private final String keyConditionExpression;
private final Map expressionAttributeNames;
private final Map expressionAttributeValues;
private QueryRequest(BuilderImpl builder) {
super(builder);
this.tableName = builder.tableName;
this.indexName = builder.indexName;
this.select = builder.select;
this.attributesToGet = builder.attributesToGet;
this.limit = builder.limit;
this.consistentRead = builder.consistentRead;
this.keyConditions = builder.keyConditions;
this.queryFilter = builder.queryFilter;
this.conditionalOperator = builder.conditionalOperator;
this.scanIndexForward = builder.scanIndexForward;
this.exclusiveStartKey = builder.exclusiveStartKey;
this.returnConsumedCapacity = builder.returnConsumedCapacity;
this.projectionExpression = builder.projectionExpression;
this.filterExpression = builder.filterExpression;
this.keyConditionExpression = builder.keyConditionExpression;
this.expressionAttributeNames = builder.expressionAttributeNames;
this.expressionAttributeValues = builder.expressionAttributeValues;
}
/**
*
* The name of the table containing the requested items.
*
*
* @return The name of the table containing the requested items.
*/
public final String tableName() {
return tableName;
}
/**
*
* The name of an index to query. This index can be any local secondary index or global secondary index on the
* table. Note that if you use the IndexName parameter, you must also provide TableName.
*
*
* @return The name of an index to query. This index can be any local secondary index or global secondary index on
* the table. Note that if you use the IndexName parameter, you must also provide
* TableName.
*/
public final String indexName() {
return indexName;
}
/**
*
* The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the
* count of matching items, or in the case of an index, some or all of the attributes projected into the index.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query
* a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the
* parent table. If the index is configured to project all item attributes, then all of the data can be obtained
* from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have
* been projected into the index. If the index is configured to project all attributes, this return value is
* equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This
* return value is equivalent to specifying AttributesToGet without specifying any value for
* Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that index, the
* operation will read only the index and not the table. If any of the requested attributes are not projected into
* the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching
* incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into the index.
* Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
* index. You cannot use both Select and AttributesToGet together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to
* specifying AttributesToGet without any value for Select.)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can only be
* SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #select} will
* return {@link Select#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #selectAsString}.
*
*
* @return The attributes to be returned in the result. You can retrieve all item attributes, specific item
* attributes, the count of matching items, or in the case of an index, some or all of the attributes
* projected into the index.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If
* you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire
* item from the parent table. If the index is configured to project all item attributes, then all of the
* data can be obtained from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes
* that have been projected into the index. If the index is configured to project all attributes, this
* return value is equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet.
* This return value is equivalent to specifying AttributesToGet without specifying any value
* for Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that
* index, the operation will read only the index and not the table. If any of the requested attributes are
* not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent
* table. This extra fetching incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into
* the index. Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
* accessing an index. You cannot use both Select and AttributesToGet together in
* a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This
* usage is equivalent to specifying AttributesToGet without any value for Select
* .)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can
* only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
*
* @see Select
*/
public final Select select() {
return Select.fromValue(select);
}
/**
*
* The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the
* count of matching items, or in the case of an index, some or all of the attributes projected into the index.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query
* a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the
* parent table. If the index is configured to project all item attributes, then all of the data can be obtained
* from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have
* been projected into the index. If the index is configured to project all attributes, this return value is
* equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This
* return value is equivalent to specifying AttributesToGet without specifying any value for
* Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that index, the
* operation will read only the index and not the table. If any of the requested attributes are not projected into
* the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching
* incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into the index.
* Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
* index. You cannot use both Select and AttributesToGet together in a single request,
* unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to
* specifying AttributesToGet without any value for Select.)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can only be
* SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #select} will
* return {@link Select#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #selectAsString}.
*
*
* @return The attributes to be returned in the result. You can retrieve all item attributes, specific item
* attributes, the count of matching items, or in the case of an index, some or all of the attributes
* projected into the index.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If
* you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire
* item from the parent table. If the index is configured to project all item attributes, then all of the
* data can be obtained from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes
* that have been projected into the index. If the index is configured to project all attributes, this
* return value is equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet.
* This return value is equivalent to specifying AttributesToGet without specifying any value
* for Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that
* index, the operation will read only the index and not the table. If any of the requested attributes are
* not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent
* table. This extra fetching incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into
* the index. Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
* accessing an index. You cannot use both Select and AttributesToGet together in
* a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This
* usage is equivalent to specifying AttributesToGet without any value for Select
* .)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can
* only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
*
* @see Select
*/
public final String selectAsString() {
return select;
}
/**
* For responses, this returns true if the service returned a value for the AttributesToGet property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasAttributesToGet() {
return attributesToGet != null && !(attributesToGet instanceof SdkAutoConstructList);
}
/**
*
* This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasAttributesToGet} method.
*
*
* @return This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*/
public final List attributesToGet() {
return attributesToGet;
}
/**
*
* The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the
* number of items up to the limit while processing the results, it stops the operation and returns the matching
* values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that
* you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this
* limit, it stops the operation and returns the matching values up to the limit, and a key in
* LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information,
* see 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 dataset size
* exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values
* up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to
* continue the operation. For more information, see Query and
* Scan in the Amazon DynamoDB Developer Guide.
*/
public final Integer limit() {
return limit;
}
/**
*
* Determines the read consistency model: If set to true, then the operation uses strongly consistent
* reads; otherwise, the operation uses eventually consistent reads.
*
*
* Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index
* with ConsistentRead set to true, you will receive a ValidationException.
*
*
* @return Determines the read consistency model: If set to true, then the operation uses strongly
* consistent reads; otherwise, the operation uses eventually consistent reads.
*
* Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary
* index with ConsistentRead set to true, you will receive a
* ValidationException.
*/
public final Boolean consistentRead() {
return consistentRead;
}
/**
* For responses, this returns true if the service returned a value for the KeyConditions property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasKeyConditions() {
return keyConditions != null && !(keyConditions instanceof SdkAutoConstructMap);
}
/**
*
* This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasKeyConditions} method.
*
*
* @return This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
*/
public final Map keyConditions() {
return keyConditions;
}
/**
* For responses, this returns true if the service returned a value for the QueryFilter property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasQueryFilter() {
return queryFilter != null && !(queryFilter instanceof SdkAutoConstructMap);
}
/**
*
* This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasQueryFilter} method.
*
*
* @return This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
*/
public final Map queryFilter() {
return queryFilter;
}
/**
*
* This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #conditionalOperator} will return {@link ConditionalOperator#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #conditionalOperatorAsString}.
*
*
* @return This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
* @see ConditionalOperator
*/
public final ConditionalOperator conditionalOperator() {
return ConditionalOperator.fromValue(conditionalOperator);
}
/**
*
* This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #conditionalOperator} will return {@link ConditionalOperator#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #conditionalOperatorAsString}.
*
*
* @return This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
* @see ConditionalOperator
*/
public final String conditionalOperatorAsString() {
return conditionalOperator;
}
/**
*
* Specifies the order for index traversal: If true (default), the traversal is performed in ascending
* order; if false, the traversal is performed in descending order.
*
*
* Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is
* Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes.
* For type Binary, DynamoDB treats each byte of the binary data as unsigned.
*
*
* If ScanIndexForward is true, DynamoDB returns the results in the order in which they
* are stored (by sort key value). This is the default behavior. If ScanIndexForward is
* false, DynamoDB reads the results in reverse order by sort key value, and then returns the results
* to the client.
*
*
* @return Specifies the order for index traversal: If true (default), the traversal is performed in
* ascending order; if false, the traversal is performed in descending order.
*
* Items with the same partition key value are stored in sorted order by sort key. If the sort key data type
* is Number, the results are stored in numeric order. For type String, the results are stored in order of
* UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
*
*
* If ScanIndexForward is true, DynamoDB returns the results in the order in which
* they are stored (by sort key value). This is the default behavior. If ScanIndexForward is
* false, DynamoDB reads the results in reverse order by sort key value, and then returns the
* results to the client.
*/
public final Boolean scanIndexForward() {
return scanIndexForward;
}
/**
* For responses, this returns true if the service returned a value for the ExclusiveStartKey property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasExclusiveStartKey() {
return exclusiveStartKey != null && !(exclusiveStartKey instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasExclusiveStartKey} method.
*
*
* @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.
*/
public final Map exclusiveStartKey() {
return exclusiveStartKey;
}
/**
* Returns the value of the ReturnConsumedCapacity property for this object.
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #returnConsumedCapacity} will return {@link ReturnConsumedCapacity#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #returnConsumedCapacityAsString}.
*
*
* @return The value of the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
*/
public final ReturnConsumedCapacity returnConsumedCapacity() {
return ReturnConsumedCapacity.fromValue(returnConsumedCapacity);
}
/**
* Returns the value of the ReturnConsumedCapacity property for this object.
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #returnConsumedCapacity} will return {@link ReturnConsumedCapacity#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #returnConsumedCapacityAsString}.
*
*
* @return The value of the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
*/
public final String returnConsumedCapacityAsString() {
return returnConsumedCapacity;
}
/**
*
* A string that identifies one or more attributes to retrieve from the table. 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.
*
*
* @return A string that identifies one or more attributes to retrieve from the table. 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.
*/
public final String projectionExpression() {
return projectionExpression;
}
/**
*
* A string that contains conditions that DynamoDB applies after the Query operation, but before the
* data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
*
*
* A FilterExpression does not allow key attributes. You cannot define a filter expression based on a
* partition key or a sort key.
*
*
*
* A FilterExpression is applied after the items have already been read; the process of filtering does
* not consume any additional read capacity units.
*
*
*
* For more information, see Filter
* Expressions in the Amazon DynamoDB Developer Guide.
*
*
* @return A string that contains conditions that DynamoDB applies after the Query operation, but
* before the data is returned to you. Items that do not satisfy the FilterExpression criteria
* are not returned.
*
* A FilterExpression does not allow key attributes. You cannot define a filter expression
* based on a partition key or a sort key.
*
*
*
* A FilterExpression is applied after the items have already been read; the process of
* filtering does not consume any additional read capacity units.
*
*
*
* For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
*/
public final String filterExpression() {
return filterExpression;
}
/**
*
* The condition that specifies the key values for items to be retrieved by the Query action.
*
*
* The condition must perform an equality test on a single partition key value.
*
*
* The condition can optionally perform one of several comparison tests on a single sort key value. This allows
* Query to retrieve one item with a given partition key value and sort key value, or several items
* that have the same partition key value but different sort key values.
*
*
* The partition key equality test is required, and must be specified in the following format:
*
*
* partitionKeyName = :partitionkeyval
*
*
* If you also want to provide a condition for the sort key, it must be combined using AND with the
* condition for the sort key. Following is an example, using the = comparison operator for the sort key:
*
*
* partitionKeyName = :partitionkeyval AND
* sortKeyName = :sortkeyval
*
*
* Valid comparisons for the sort key condition are as follows:
*
*
* -
*
* sortKeyName = :sortkeyval - true if the sort key value is equal to
* :sortkeyval.
*
*
* -
*
* sortKeyName < :sortkeyval - true if the sort key value is less than
* :sortkeyval.
*
*
* -
*
* sortKeyName <= :sortkeyval - true if the sort key value is less than or
* equal to :sortkeyval.
*
*
* -
*
* sortKeyName > :sortkeyval - true if the sort key value is greater than
* :sortkeyval.
*
*
* -
*
* sortKeyName >= :sortkeyval - true if the sort key value is greater
* than or equal to :sortkeyval.
*
*
* -
*
* sortKeyName BETWEEN :sortkeyval1 AND
* :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and
* less than or equal to :sortkeyval2.
*
*
* -
*
* begins_with ( sortKeyName, :sortkeyval ) - true if the sort
* key value begins with a particular operand. (You cannot use this function with a sort key that is of type
* Number.) Note that the function name begins_with is case-sensitive.
*
*
*
*
* Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and
* :sortval with actual values at runtime.
*
*
* You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition
* key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a
* DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error
* because Size is a reserved word:
*
*
* -
*
* Size = :myval
*
*
*
*
* To work around this, define a placeholder (such a #S) to represent the attribute name Size.
* KeyConditionExpression then is as follows:
*
*
* -
*
* #S = :myval
*
*
*
*
* For a list of reserved words, see Reserved Words in
* the Amazon DynamoDB Developer Guide.
*
*
* For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using
* Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
*
*
* @return The condition that specifies the key values for items to be retrieved by the Query
* action.
*
* The condition must perform an equality test on a single partition key value.
*
*
* The condition can optionally perform one of several comparison tests on a single sort key value. This
* allows Query to retrieve one item with a given partition key value and sort key value, or
* several items that have the same partition key value but different sort key values.
*
*
* The partition key equality test is required, and must be specified in the following format:
*
*
* partitionKeyName = :partitionkeyval
*
*
* If you also want to provide a condition for the sort key, it must be combined using AND with
* the condition for the sort key. Following is an example, using the = comparison operator for the
* sort key:
*
*
* partitionKeyName = :partitionkeyval AND
* sortKeyName = :sortkeyval
*
*
* Valid comparisons for the sort key condition are as follows:
*
*
* -
*
* sortKeyName = :sortkeyval - true if the sort key value is equal to
* :sortkeyval.
*
*
* -
*
* sortKeyName < :sortkeyval - true if the sort key value is less
* than :sortkeyval.
*
*
* -
*
* sortKeyName <= :sortkeyval - true if the sort key value is less
* than or equal to :sortkeyval.
*
*
* -
*
* sortKeyName > :sortkeyval - true if the sort key value is
* greater than :sortkeyval.
*
*
* -
*
* sortKeyName >= :sortkeyval - true if the sort key value is
* greater than or equal to :sortkeyval.
*
*
* -
*
* sortKeyName BETWEEN :sortkeyval1 AND
* :sortkeyval2 - true if the sort key value is greater than or equal to
* :sortkeyval1, and less than or equal to :sortkeyval2.
*
*
* -
*
* begins_with ( sortKeyName, :sortkeyval ) - true if
* the sort key value begins with a particular operand. (You cannot use this function with a sort key that
* is of type Number.) Note that the function name begins_with is case-sensitive.
*
*
*
*
* Use the ExpressionAttributeValues parameter to replace tokens such as
* :partitionval and :sortval with actual values at runtime.
*
*
* You can optionally use the ExpressionAttributeNames parameter to replace the names of the
* partition key and sort key with placeholder tokens. This option might be necessary if an attribute name
* conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression
* parameter causes an error because Size is a reserved word:
*
*
* -
*
* Size = :myval
*
*
*
*
* To work around this, define a placeholder (such a #S) to represent the attribute name
* Size. KeyConditionExpression then is as follows:
*
*
* -
*
* #S = :myval
*
*
*
*
* For a list of reserved words, see Reserved
* Words in the Amazon DynamoDB Developer Guide.
*
*
* For more information on ExpressionAttributeNames and ExpressionAttributeValues,
* see Using
* Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
*/
public final String keyConditionExpression() {
return keyConditionExpression;
}
/**
* For responses, this returns true if the service returned a value for the ExpressionAttributeNames property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasExpressionAttributeNames() {
return expressionAttributeNames != null && !(expressionAttributeNames instanceof SdkAutoConstructMap);
}
/**
*
* One or more substitution tokens for attribute names in an expression. The following are some use cases for using
* ExpressionAttributeNames:
*
*
* -
*
* To access an attribute whose name conflicts with a DynamoDB reserved word.
*
*
* -
*
* To create a placeholder for repeating occurrences of an attribute name in an expression.
*
*
* -
*
* To prevent special characters in an attribute name from being misinterpreted in an expression.
*
*
*
*
* Use the # character in an expression to dereference an attribute name. For example, consider the following
* attribute name:
*
*
* -
*
* Percentile
*
*
*
*
* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
* the complete list of reserved words, see Reserved Words in
* the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
* ExpressionAttributeNames:
*
*
* -
*
* {"#P":"Percentile"}
*
*
*
*
* You could then use this substitution in an expression, as in this example:
*
*
* -
*
* #P = :val
*
*
*
*
*
* Tokens that begin with the : character are expression attribute values, which are placeholders for
* the actual value at runtime.
*
*
*
* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasExpressionAttributeNames} method.
*
*
* @return One or more substitution tokens for attribute names in an expression. The following are some use cases
* for using ExpressionAttributeNames:
*
* -
*
* To access an attribute whose name conflicts with a DynamoDB reserved word.
*
*
* -
*
* To create a placeholder for repeating occurrences of an attribute name in an expression.
*
*
* -
*
* To prevent special characters in an attribute name from being misinterpreted in an expression.
*
*
*
*
* Use the # character in an expression to dereference an attribute name. For example, consider the
* following attribute name:
*
*
* -
*
* Percentile
*
*
*
*
* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an
* expression. (For the complete list of reserved words, see Reserved
* Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
* following for ExpressionAttributeNames:
*
*
* -
*
* {"#P":"Percentile"}
*
*
*
*
* You could then use this substitution in an expression, as in this example:
*
*
* -
*
* #P = :val
*
*
*
*
*
* Tokens that begin with the : character are expression attribute values, which are
* placeholders for the actual value at runtime.
*
*
*
* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
*/
public final Map expressionAttributeNames() {
return expressionAttributeNames;
}
/**
* For responses, this returns true if the service returned a value for the ExpressionAttributeValues property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasExpressionAttributeValues() {
return expressionAttributeValues != null && !(expressionAttributeValues instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasExpressionAttributeValues} method.
*
*
* @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 final Map expressionAttributeValues() {
return expressionAttributeValues;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(tableName());
hashCode = 31 * hashCode + Objects.hashCode(indexName());
hashCode = 31 * hashCode + Objects.hashCode(selectAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasAttributesToGet() ? attributesToGet() : null);
hashCode = 31 * hashCode + Objects.hashCode(limit());
hashCode = 31 * hashCode + Objects.hashCode(consistentRead());
hashCode = 31 * hashCode + Objects.hashCode(hasKeyConditions() ? keyConditions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasQueryFilter() ? queryFilter() : null);
hashCode = 31 * hashCode + Objects.hashCode(conditionalOperatorAsString());
hashCode = 31 * hashCode + Objects.hashCode(scanIndexForward());
hashCode = 31 * hashCode + Objects.hashCode(hasExclusiveStartKey() ? exclusiveStartKey() : null);
hashCode = 31 * hashCode + Objects.hashCode(returnConsumedCapacityAsString());
hashCode = 31 * hashCode + Objects.hashCode(projectionExpression());
hashCode = 31 * hashCode + Objects.hashCode(filterExpression());
hashCode = 31 * hashCode + Objects.hashCode(keyConditionExpression());
hashCode = 31 * hashCode + Objects.hashCode(hasExpressionAttributeNames() ? expressionAttributeNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasExpressionAttributeValues() ? expressionAttributeValues() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof QueryRequest)) {
return false;
}
QueryRequest other = (QueryRequest) obj;
return Objects.equals(tableName(), other.tableName()) && Objects.equals(indexName(), other.indexName())
&& Objects.equals(selectAsString(), other.selectAsString()) && hasAttributesToGet() == other.hasAttributesToGet()
&& Objects.equals(attributesToGet(), other.attributesToGet()) && Objects.equals(limit(), other.limit())
&& Objects.equals(consistentRead(), other.consistentRead()) && hasKeyConditions() == other.hasKeyConditions()
&& Objects.equals(keyConditions(), other.keyConditions()) && hasQueryFilter() == other.hasQueryFilter()
&& Objects.equals(queryFilter(), other.queryFilter())
&& Objects.equals(conditionalOperatorAsString(), other.conditionalOperatorAsString())
&& Objects.equals(scanIndexForward(), other.scanIndexForward())
&& hasExclusiveStartKey() == other.hasExclusiveStartKey()
&& Objects.equals(exclusiveStartKey(), other.exclusiveStartKey())
&& Objects.equals(returnConsumedCapacityAsString(), other.returnConsumedCapacityAsString())
&& Objects.equals(projectionExpression(), other.projectionExpression())
&& Objects.equals(filterExpression(), other.filterExpression())
&& Objects.equals(keyConditionExpression(), other.keyConditionExpression())
&& hasExpressionAttributeNames() == other.hasExpressionAttributeNames()
&& Objects.equals(expressionAttributeNames(), other.expressionAttributeNames())
&& hasExpressionAttributeValues() == other.hasExpressionAttributeValues()
&& Objects.equals(expressionAttributeValues(), other.expressionAttributeValues());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("QueryRequest").add("TableName", tableName()).add("IndexName", indexName())
.add("Select", selectAsString()).add("AttributesToGet", hasAttributesToGet() ? attributesToGet() : null)
.add("Limit", limit()).add("ConsistentRead", consistentRead())
.add("KeyConditions", hasKeyConditions() ? keyConditions() : null)
.add("QueryFilter", hasQueryFilter() ? queryFilter() : null)
.add("ConditionalOperator", conditionalOperatorAsString()).add("ScanIndexForward", scanIndexForward())
.add("ExclusiveStartKey", hasExclusiveStartKey() ? exclusiveStartKey() : null)
.add("ReturnConsumedCapacity", returnConsumedCapacityAsString())
.add("ProjectionExpression", projectionExpression()).add("FilterExpression", filterExpression())
.add("KeyConditionExpression", keyConditionExpression())
.add("ExpressionAttributeNames", hasExpressionAttributeNames() ? expressionAttributeNames() : null)
.add("ExpressionAttributeValues", hasExpressionAttributeValues() ? expressionAttributeValues() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TableName":
return Optional.ofNullable(clazz.cast(tableName()));
case "IndexName":
return Optional.ofNullable(clazz.cast(indexName()));
case "Select":
return Optional.ofNullable(clazz.cast(selectAsString()));
case "AttributesToGet":
return Optional.ofNullable(clazz.cast(attributesToGet()));
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
case "ConsistentRead":
return Optional.ofNullable(clazz.cast(consistentRead()));
case "KeyConditions":
return Optional.ofNullable(clazz.cast(keyConditions()));
case "QueryFilter":
return Optional.ofNullable(clazz.cast(queryFilter()));
case "ConditionalOperator":
return Optional.ofNullable(clazz.cast(conditionalOperatorAsString()));
case "ScanIndexForward":
return Optional.ofNullable(clazz.cast(scanIndexForward()));
case "ExclusiveStartKey":
return Optional.ofNullable(clazz.cast(exclusiveStartKey()));
case "ReturnConsumedCapacity":
return Optional.ofNullable(clazz.cast(returnConsumedCapacityAsString()));
case "ProjectionExpression":
return Optional.ofNullable(clazz.cast(projectionExpression()));
case "FilterExpression":
return Optional.ofNullable(clazz.cast(filterExpression()));
case "KeyConditionExpression":
return Optional.ofNullable(clazz.cast(keyConditionExpression()));
case "ExpressionAttributeNames":
return Optional.ofNullable(clazz.cast(expressionAttributeNames()));
case "ExpressionAttributeValues":
return Optional.ofNullable(clazz.cast(expressionAttributeValues()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((QueryRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the table containing the requested items.
*
*
* @param tableName
* The name of the table containing the requested items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tableName(String tableName);
/**
*
* The name of an index to query. This index can be any local secondary index or global secondary index on the
* table. Note that if you use the IndexName parameter, you must also provide
* TableName.
*
*
* @param indexName
* The name of an index to query. This index can be any local secondary index or global secondary index
* on the table. 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.
*/
Builder indexName(String indexName);
/**
*
* The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes,
* the count of matching items, or in the case of an index, some or all of the attributes projected into the
* index.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you
* query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item
* from the parent table. If the index is configured to project all item attributes, then all of the data can be
* obtained from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that
* have been projected into the index. If the index is configured to project all attributes, this return value
* is equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This
* return value is equivalent to specifying AttributesToGet without specifying any value for
* Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that index,
* the operation will read only the index and not the table. If any of the requested attributes are not
* projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table.
* This extra fetching incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into the
* index. Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing
* an index. You cannot use both Select and AttributesToGet together in a single
* request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is
* equivalent to specifying AttributesToGet without any value for Select.)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can only
* be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
*
*
*
* @param select
* The attributes to be returned in the result. You can retrieve all item attributes, specific item
* attributes, the count of matching items, or in the case of an index, some or all of the attributes
* projected into the index.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If
* you query a local secondary index, then for each matching item in the index, DynamoDB fetches the
* entire item from the parent table. If the index is configured to project all item attributes, then all
* of the data can be obtained from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes
* that have been projected into the index. If the index is configured to project all attributes, this
* return value is equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet.
* This return value is equivalent to specifying AttributesToGet without specifying any
* value for Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that
* index, the operation will read only the index and not the table. If any of the requested attributes
* are not projected into the local secondary index, DynamoDB fetches each of these attributes from the
* parent table. This extra fetching incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into
* the index. Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
* accessing an index. You cannot use both Select and AttributesToGet together
* in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without any value for
* Select.)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can
* only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an
* error.
*
* @see Select
* @return Returns a reference to this object so that method calls can be chained together.
* @see Select
*/
Builder select(String select);
/**
*
* The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes,
* the count of matching items, or in the case of an index, some or all of the attributes projected into the
* index.
*
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you
* query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item
* from the parent table. If the index is configured to project all item attributes, then all of the data can be
* obtained from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that
* have been projected into the index. If the index is configured to project all attributes, this return value
* is equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This
* return value is equivalent to specifying AttributesToGet without specifying any value for
* Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that index,
* the operation will read only the index and not the table. If any of the requested attributes are not
* projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table.
* This extra fetching incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into the
* index. Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing
* an index. You cannot use both Select and AttributesToGet together in a single
* request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is
* equivalent to specifying AttributesToGet without any value for Select.)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can only
* be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
*
*
*
* @param select
* The attributes to be returned in the result. You can retrieve all item attributes, specific item
* attributes, the count of matching items, or in the case of an index, some or all of the attributes
* projected into the index.
*
* -
*
* ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If
* you query a local secondary index, then for each matching item in the index, DynamoDB fetches the
* entire item from the parent table. If the index is configured to project all item attributes, then all
* of the data can be obtained from the local secondary index, and no fetching is required.
*
*
* -
*
* ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes
* that have been projected into the index. If the index is configured to project all attributes, this
* return value is equivalent to specifying ALL_ATTRIBUTES.
*
*
* -
*
* COUNT - Returns the number of matching items, rather than the matching items themselves.
*
*
* -
*
* SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet.
* This return value is equivalent to specifying AttributesToGet without specifying any
* value for Select.
*
*
* If you query or scan a local secondary index and request only attributes that are projected into that
* index, the operation will read only the index and not the table. If any of the requested attributes
* are not projected into the local secondary index, DynamoDB fetches each of these attributes from the
* parent table. This extra fetching incurs additional throughput cost and latency.
*
*
* If you query or scan a global secondary index, you can only request attributes that are projected into
* the index. Global secondary index queries cannot fetch attributes from the parent table.
*
*
*
*
* If neither Select nor AttributesToGet are specified, DynamoDB defaults to
* ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
* accessing an index. You cannot use both Select and AttributesToGet together
* in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
* (This usage is equivalent to specifying AttributesToGet without any value for
* Select.)
*
*
*
* If you use the ProjectionExpression parameter, then the value for Select can
* only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an
* error.
*
* @see Select
* @return Returns a reference to this object so that method calls can be chained together.
* @see Select
*/
Builder select(Select select);
/**
*
* This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
* @param attributesToGet
* This is a legacy parameter. Use ProjectionExpression instead. For more information, see
* AttributesToGet in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributesToGet(Collection attributesToGet);
/**
*
* This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
* @param attributesToGet
* This is a legacy parameter. Use ProjectionExpression instead. For more information, see
* AttributesToGet in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributesToGet(String... attributesToGet);
/**
*
* The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes
* the number of items up to the limit while processing the results, it stops the operation and returns the
* matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent
* operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB
* before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit,
* and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For
* more information, see 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 dataset size
* exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching
* values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation
* to continue the operation. For more information, see Query and
* Scan in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
/**
*
* Determines the read consistency model: If set to true, then the operation uses strongly
* consistent reads; otherwise, the operation uses eventually consistent reads.
*
*
* Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary
* index with ConsistentRead set to true, you will receive a
* ValidationException.
*
*
* @param consistentRead
* Determines the read consistency model: If set to true, then the operation uses strongly
* consistent reads; otherwise, the operation uses eventually consistent reads.
*
* Strongly consistent reads are not supported on global secondary indexes. If you query 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.
*/
Builder consistentRead(Boolean consistentRead);
/**
*
* This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
*
*
* @param keyConditions
* This is a legacy parameter. Use KeyConditionExpression instead. For more information, see
* KeyConditions in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyConditions(Map keyConditions);
/**
*
* This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
*
*
* @param queryFilter
* This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder queryFilter(Map queryFilter);
/**
*
* This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
*
*
* @param conditionalOperator
* This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
* @see ConditionalOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConditionalOperator
*/
Builder conditionalOperator(String conditionalOperator);
/**
*
* This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
*
*
* @param conditionalOperator
* This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
* @see ConditionalOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConditionalOperator
*/
Builder conditionalOperator(ConditionalOperator conditionalOperator);
/**
*
* Specifies the order for index traversal: If true (default), the traversal is performed in
* ascending order; if false, the traversal is performed in descending order.
*
*
* Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is
* Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8
* bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
*
*
* If ScanIndexForward is true, DynamoDB returns the results in the order in which
* they are stored (by sort key value). This is the default behavior. If ScanIndexForward is
* false, DynamoDB reads the results in reverse order by sort key value, and then returns the
* results to the client.
*
*
* @param scanIndexForward
* Specifies the order for index traversal: If true (default), the traversal is performed in
* ascending order; if false, the traversal is performed in descending order.
*
* Items with the same partition key value are stored in sorted order by sort key. If the sort key data
* type is Number, the results are stored in numeric order. For type String, the results are stored in
* order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
*
*
* If ScanIndexForward is true, DynamoDB returns the results in the order in
* which they are stored (by sort key value). This is the default behavior. If
* ScanIndexForward is false, DynamoDB reads the results in reverse order by
* sort key value, and then returns the results to the client.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scanIndexForward(Boolean scanIndexForward);
/**
*
* 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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder exclusiveStartKey(Map exclusiveStartKey);
/**
* Sets the value of the ReturnConsumedCapacity property for this object.
*
* @param returnConsumedCapacity
* The new value for the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnConsumedCapacity
*/
Builder returnConsumedCapacity(String returnConsumedCapacity);
/**
* Sets the value of the ReturnConsumedCapacity property for this object.
*
* @param returnConsumedCapacity
* The new value for the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnConsumedCapacity
*/
Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity);
/**
*
* A string that identifies one or more attributes to retrieve from the table. 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.
*
*
* @param projectionExpression
* A string that identifies one or more attributes to retrieve from the table. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder projectionExpression(String projectionExpression);
/**
*
* A string that contains conditions that DynamoDB applies after the Query operation, but before
* the data is returned to you. Items that do not satisfy the FilterExpression criteria are not
* returned.
*
*
* A FilterExpression does not allow key attributes. You cannot define a filter expression based on
* a partition key or a sort key.
*
*
*
* A FilterExpression is applied after the items have already been read; the process of filtering
* does not consume any additional read capacity units.
*
*
*
* For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
*
*
* @param filterExpression
* A string that contains conditions that DynamoDB applies after the Query operation, but
* before the data is returned to you. Items that do not satisfy the FilterExpression
* criteria are not returned.
*
* A FilterExpression does not allow key attributes. You cannot define a filter expression
* based on a partition key or a sort key.
*
*
*
* A FilterExpression is applied after the items have already been read; the process of
* filtering does not consume any additional read capacity units.
*
*
*
* For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filterExpression(String filterExpression);
/**
*
* The condition that specifies the key values for items to be retrieved by the Query action.
*
*
* The condition must perform an equality test on a single partition key value.
*
*
* The condition can optionally perform one of several comparison tests on a single sort key value. This allows
* Query to retrieve one item with a given partition key value and sort key value, or several items
* that have the same partition key value but different sort key values.
*
*
* The partition key equality test is required, and must be specified in the following format:
*
*
* partitionKeyName = :partitionkeyval
*
*
* If you also want to provide a condition for the sort key, it must be combined using AND with the
* condition for the sort key. Following is an example, using the = comparison operator for the sort key:
*
*
* partitionKeyName = :partitionkeyval AND
* sortKeyName = :sortkeyval
*
*
* Valid comparisons for the sort key condition are as follows:
*
*
* -
*
* sortKeyName = :sortkeyval - true if the sort key value is equal to
* :sortkeyval.
*
*
* -
*
* sortKeyName < :sortkeyval - true if the sort key value is less than
* :sortkeyval.
*
*
* -
*
* sortKeyName <= :sortkeyval - true if the sort key value is less
* than or equal to :sortkeyval.
*
*
* -
*
* sortKeyName > :sortkeyval - true if the sort key value is greater
* than :sortkeyval.
*
*
* -
*
* sortKeyName >= :sortkeyval - true if the sort key value is greater
* than or equal to :sortkeyval.
*
*
* -
*
* sortKeyName BETWEEN :sortkeyval1 AND
* :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1,
* and less than or equal to :sortkeyval2.
*
*
* -
*
* begins_with ( sortKeyName, :sortkeyval ) - true if the
* sort key value begins with a particular operand. (You cannot use this function with a sort key that is of
* type Number.) Note that the function name begins_with is case-sensitive.
*
*
*
*
* Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
* and :sortval with actual values at runtime.
*
*
* You can optionally use the ExpressionAttributeNames parameter to replace the names of the
* partition key and sort key with placeholder tokens. This option might be necessary if an attribute name
* conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression
* parameter causes an error because Size is a reserved word:
*
*
* -
*
* Size = :myval
*
*
*
*
* To work around this, define a placeholder (such a #S) to represent the attribute name
* Size. KeyConditionExpression then is as follows:
*
*
* -
*
* #S = :myval
*
*
*
*
* For a list of reserved words, see Reserved Words
* in the Amazon DynamoDB Developer Guide.
*
*
* For more information on ExpressionAttributeNames and ExpressionAttributeValues, see
* Using
* Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
*
*
* @param keyConditionExpression
* The condition that specifies the key values for items to be retrieved by the Query
* action.
*
* The condition must perform an equality test on a single partition key value.
*
*
* The condition can optionally perform one of several comparison tests on a single sort key value. This
* allows Query to retrieve one item with a given partition key value and sort key value, or
* several items that have the same partition key value but different sort key values.
*
*
* The partition key equality test is required, and must be specified in the following format:
*
*
* partitionKeyName = :partitionkeyval
*
*
* If you also want to provide a condition for the sort key, it must be combined using AND
* with the condition for the sort key. Following is an example, using the = comparison operator
* for the sort key:
*
*
* partitionKeyName = :partitionkeyval AND
* sortKeyName = :sortkeyval
*
*
* Valid comparisons for the sort key condition are as follows:
*
*
* -
*
* sortKeyName = :sortkeyval - true if the sort key value is equal
* to :sortkeyval.
*
*
* -
*
* sortKeyName < :sortkeyval - true if the sort key value is
* less than :sortkeyval.
*
*
* -
*
* sortKeyName <= :sortkeyval - true if the sort key value is
* less than or equal to :sortkeyval.
*
*
* -
*
* sortKeyName > :sortkeyval - true if the sort key value is
* greater than :sortkeyval.
*
*
* -
*
* sortKeyName >= :sortkeyval - true if the sort key value is
* greater than or equal to :sortkeyval.
*
*
* -
*
* sortKeyName BETWEEN :sortkeyval1 AND
* :sortkeyval2 - true if the sort key value is greater than or equal to
* :sortkeyval1, and less than or equal to :sortkeyval2.
*
*
* -
*
* begins_with ( sortKeyName, :sortkeyval ) - true if
* the sort key value begins with a particular operand. (You cannot use this function with a sort key
* that is of type Number.) Note that the function name begins_with is case-sensitive.
*
*
*
*
* Use the ExpressionAttributeValues parameter to replace tokens such as
* :partitionval and :sortval with actual values at runtime.
*
*
* You can optionally use the ExpressionAttributeNames parameter to replace the names of the
* partition key and sort key with placeholder tokens. This option might be necessary if an attribute
* name conflicts with a DynamoDB reserved word. For example, the following
* KeyConditionExpression parameter causes an error because Size is a reserved word:
*
*
* -
*
* Size = :myval
*
*
*
*
* To work around this, define a placeholder (such a #S) to represent the attribute name
* Size. KeyConditionExpression then is as follows:
*
*
* -
*
* #S = :myval
*
*
*
*
* For a list of reserved words, see Reserved
* Words in the Amazon DynamoDB Developer Guide.
*
*
* For more information on ExpressionAttributeNames and
* ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyConditionExpression(String keyConditionExpression);
/**
*
* One or more substitution tokens for attribute names in an expression. The following are some use cases for
* using ExpressionAttributeNames:
*
*
* -
*
* To access an attribute whose name conflicts with a DynamoDB reserved word.
*
*
* -
*
* To create a placeholder for repeating occurrences of an attribute name in an expression.
*
*
* -
*
* To prevent special characters in an attribute name from being misinterpreted in an expression.
*
*
*
*
* Use the # character in an expression to dereference an attribute name. For example, consider the
* following attribute name:
*
*
* -
*
* Percentile
*
*
*
*
* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression.
* (For the complete list of reserved words, see Reserved Words
* in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
* ExpressionAttributeNames:
*
*
* -
*
* {"#P":"Percentile"}
*
*
*
*
* You could then use this substitution in an expression, as in this example:
*
*
* -
*
* #P = :val
*
*
*
*
*
* Tokens that begin with the : character are expression attribute values, which are placeholders
* for the actual value at runtime.
*
*
*
* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* @param expressionAttributeNames
* One or more substitution tokens for attribute names in an expression. The following are some use cases
* for using ExpressionAttributeNames:
*
* -
*
* To access an attribute whose name conflicts with a DynamoDB reserved word.
*
*
* -
*
* To create a placeholder for repeating occurrences of an attribute name in an expression.
*
*
* -
*
* To prevent special characters in an attribute name from being misinterpreted in an expression.
*
*
*
*
* Use the # character in an expression to dereference an attribute name. For example, consider
* the following attribute name:
*
*
* -
*
* Percentile
*
*
*
*
* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an
* expression. (For the complete list of reserved words, see Reserved
* Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
* following for ExpressionAttributeNames:
*
*
* -
*
* {"#P":"Percentile"}
*
*
*
*
* You could then use this substitution in an expression, as in this example:
*
*
* -
*
* #P = :val
*
*
*
*
*
* Tokens that begin with the : character are expression attribute values, which are
* placeholders for the actual value at runtime.
*
*
*
* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expressionAttributeNames(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.
*
*
* @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.
*/
Builder expressionAttributeValues(Map expressionAttributeValues);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DynamoDbRequest.BuilderImpl implements Builder {
private String tableName;
private String indexName;
private String select;
private List attributesToGet = DefaultSdkAutoConstructList.getInstance();
private Integer limit;
private Boolean consistentRead;
private Map keyConditions = DefaultSdkAutoConstructMap.getInstance();
private Map queryFilter = DefaultSdkAutoConstructMap.getInstance();
private String conditionalOperator;
private Boolean scanIndexForward;
private Map exclusiveStartKey = DefaultSdkAutoConstructMap.getInstance();
private String returnConsumedCapacity;
private String projectionExpression;
private String filterExpression;
private String keyConditionExpression;
private Map expressionAttributeNames = DefaultSdkAutoConstructMap.getInstance();
private Map expressionAttributeValues = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(QueryRequest model) {
super(model);
tableName(model.tableName);
indexName(model.indexName);
select(model.select);
attributesToGet(model.attributesToGet);
limit(model.limit);
consistentRead(model.consistentRead);
keyConditions(model.keyConditions);
queryFilter(model.queryFilter);
conditionalOperator(model.conditionalOperator);
scanIndexForward(model.scanIndexForward);
exclusiveStartKey(model.exclusiveStartKey);
returnConsumedCapacity(model.returnConsumedCapacity);
projectionExpression(model.projectionExpression);
filterExpression(model.filterExpression);
keyConditionExpression(model.keyConditionExpression);
expressionAttributeNames(model.expressionAttributeNames);
expressionAttributeValues(model.expressionAttributeValues);
}
public final String getTableName() {
return tableName;
}
public final void setTableName(String tableName) {
this.tableName = tableName;
}
@Override
public final Builder tableName(String tableName) {
this.tableName = tableName;
return this;
}
public final String getIndexName() {
return indexName;
}
public final void setIndexName(String indexName) {
this.indexName = indexName;
}
@Override
public final Builder indexName(String indexName) {
this.indexName = indexName;
return this;
}
public final String getSelect() {
return select;
}
public final void setSelect(String select) {
this.select = select;
}
@Override
public final Builder select(String select) {
this.select = select;
return this;
}
@Override
public final Builder select(Select select) {
this.select(select == null ? null : select.toString());
return this;
}
public final Collection getAttributesToGet() {
if (attributesToGet instanceof SdkAutoConstructList) {
return null;
}
return attributesToGet;
}
public final void setAttributesToGet(Collection attributesToGet) {
this.attributesToGet = AttributeNameListCopier.copy(attributesToGet);
}
@Override
public final Builder attributesToGet(Collection attributesToGet) {
this.attributesToGet = AttributeNameListCopier.copy(attributesToGet);
return this;
}
@Override
@SafeVarargs
public final Builder attributesToGet(String... attributesToGet) {
attributesToGet(Arrays.asList(attributesToGet));
return this;
}
public final Integer getLimit() {
return limit;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final Boolean getConsistentRead() {
return consistentRead;
}
public final void setConsistentRead(Boolean consistentRead) {
this.consistentRead = consistentRead;
}
@Override
public final Builder consistentRead(Boolean consistentRead) {
this.consistentRead = consistentRead;
return this;
}
public final Map getKeyConditions() {
Map result = KeyConditionsCopier.copyToBuilder(this.keyConditions);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setKeyConditions(Map keyConditions) {
this.keyConditions = KeyConditionsCopier.copyFromBuilder(keyConditions);
}
@Override
public final Builder keyConditions(Map keyConditions) {
this.keyConditions = KeyConditionsCopier.copy(keyConditions);
return this;
}
public final Map getQueryFilter() {
Map result = FilterConditionMapCopier.copyToBuilder(this.queryFilter);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setQueryFilter(Map queryFilter) {
this.queryFilter = FilterConditionMapCopier.copyFromBuilder(queryFilter);
}
@Override
public final Builder queryFilter(Map queryFilter) {
this.queryFilter = FilterConditionMapCopier.copy(queryFilter);
return this;
}
public final String getConditionalOperator() {
return conditionalOperator;
}
public final void setConditionalOperator(String conditionalOperator) {
this.conditionalOperator = conditionalOperator;
}
@Override
public final Builder conditionalOperator(String conditionalOperator) {
this.conditionalOperator = conditionalOperator;
return this;
}
@Override
public final Builder conditionalOperator(ConditionalOperator conditionalOperator) {
this.conditionalOperator(conditionalOperator == null ? null : conditionalOperator.toString());
return this;
}
public final Boolean getScanIndexForward() {
return scanIndexForward;
}
public final void setScanIndexForward(Boolean scanIndexForward) {
this.scanIndexForward = scanIndexForward;
}
@Override
public final Builder scanIndexForward(Boolean scanIndexForward) {
this.scanIndexForward = scanIndexForward;
return this;
}
public final Map getExclusiveStartKey() {
Map result = KeyCopier.copyToBuilder(this.exclusiveStartKey);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setExclusiveStartKey(Map exclusiveStartKey) {
this.exclusiveStartKey = KeyCopier.copyFromBuilder(exclusiveStartKey);
}
@Override
public final Builder exclusiveStartKey(Map exclusiveStartKey) {
this.exclusiveStartKey = KeyCopier.copy(exclusiveStartKey);
return this;
}
public final String getReturnConsumedCapacity() {
return returnConsumedCapacity;
}
public final void setReturnConsumedCapacity(String returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity;
}
@Override
public final Builder returnConsumedCapacity(String returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity;
return this;
}
@Override
public final Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) {
this.returnConsumedCapacity(returnConsumedCapacity == null ? null : returnConsumedCapacity.toString());
return this;
}
public final String getProjectionExpression() {
return projectionExpression;
}
public final void setProjectionExpression(String projectionExpression) {
this.projectionExpression = projectionExpression;
}
@Override
public final Builder projectionExpression(String projectionExpression) {
this.projectionExpression = projectionExpression;
return this;
}
public final String getFilterExpression() {
return filterExpression;
}
public final void setFilterExpression(String filterExpression) {
this.filterExpression = filterExpression;
}
@Override
public final Builder filterExpression(String filterExpression) {
this.filterExpression = filterExpression;
return this;
}
public final String getKeyConditionExpression() {
return keyConditionExpression;
}
public final void setKeyConditionExpression(String keyConditionExpression) {
this.keyConditionExpression = keyConditionExpression;
}
@Override
public final Builder keyConditionExpression(String keyConditionExpression) {
this.keyConditionExpression = keyConditionExpression;
return this;
}
public final Map getExpressionAttributeNames() {
if (expressionAttributeNames instanceof SdkAutoConstructMap) {
return null;
}
return expressionAttributeNames;
}
public final void setExpressionAttributeNames(Map expressionAttributeNames) {
this.expressionAttributeNames = ExpressionAttributeNameMapCopier.copy(expressionAttributeNames);
}
@Override
public final Builder expressionAttributeNames(Map expressionAttributeNames) {
this.expressionAttributeNames = ExpressionAttributeNameMapCopier.copy(expressionAttributeNames);
return this;
}
public final Map getExpressionAttributeValues() {
Map result = ExpressionAttributeValueMapCopier
.copyToBuilder(this.expressionAttributeValues);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setExpressionAttributeValues(Map expressionAttributeValues) {
this.expressionAttributeValues = ExpressionAttributeValueMapCopier.copyFromBuilder(expressionAttributeValues);
}
@Override
public final Builder expressionAttributeValues(Map expressionAttributeValues) {
this.expressionAttributeValues = ExpressionAttributeValueMapCopier.copy(expressionAttributeValues);
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public QueryRequest build() {
return new QueryRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}