/*
* 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.
*/
/*
* Do not modify this file. This file is generated from the dynamodb-2012-08-10.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.DynamoDBv2.Model
{
///
/// Container for the parameters to the Query operation.
/// You must provide the name of the partition key attribute and a single value for that
/// attribute. Query
returns all items with that partition key value. Optionally,
/// you can provide a sort key attribute and use a comparison operator to refine the search
/// results.
///
///
///
/// Use the KeyConditionExpression
parameter to provide a specific value
/// for the partition key. The Query
operation will return all of the items
/// from the table or index with that partition key value. You can optionally narrow the
/// scope of the Query
operation by specifying a sort key value and a comparison
/// operator in KeyConditionExpression
. To further refine the Query
/// results, you can optionally provide a FilterExpression
. A FilterExpression
/// determines which items within the results should be returned to you. All of the other
/// results are discarded.
///
///
///
/// A Query
operation always returns a result set. If no matching items
/// are found, the result set will be empty. Queries that do not return results consume
/// the minimum number of read capacity units for that type of read operation.
///
///
///
/// DynamoDB calculates the number of read capacity units consumed based on item size,
/// not on the amount of data that is returned to an application. The number of capacity
/// units consumed will be the same whether you request all of the attributes (the default
/// behavior) or just some of them (using a projection expression). The number will also
/// be the same whether or not you use a FilterExpression
.
///
///
///
/// Query
results are always sorted by the sort key value. If the data type
/// of the sort key is Number, the results are returned in numeric order; otherwise, the
/// results are returned in order of UTF-8 bytes. By default, the sort order is ascending.
/// To reverse the order, set the ScanIndexForward
parameter to false.
///
///
///
/// A single Query
operation will read up to the maximum number of items
/// set (if using the Limit
parameter) or a maximum of 1 MB of data and then
/// apply any filtering to the results using FilterExpression
. If LastEvaluatedKey
/// is present in the response, you will need to paginate the result set. For more information,
/// see Paginating
/// the Results in the Amazon DynamoDB Developer Guide.
///
///
///
/// FilterExpression
is applied after a Query
finishes, but
/// before the results are returned. A FilterExpression
cannot contain partition
/// key or sort key attributes. You need to specify those attributes in the KeyConditionExpression
.
///
///
///
///
/// A Query
operation can return an empty result set and a LastEvaluatedKey
/// if all the items read for the page of results are filtered out.
///
///
///
/// You can query a table, a local secondary index, or a global secondary index. For a
/// query on a table or on a local secondary index, you can set the ConsistentRead
/// parameter to true
and obtain a strongly consistent result. Global secondary
/// indexes support eventually consistent reads only, so do not specify ConsistentRead
/// when querying a global secondary index.
///
///
public partial class QueryRequest : AmazonDynamoDBRequest
{
private List _attributesToGet = new List();
private ConditionalOperator _conditionalOperator;
private bool? _consistentRead;
private Dictionary _exclusiveStartKey = new Dictionary();
private Dictionary _expressionAttributeNames = new Dictionary();
private Dictionary _expressionAttributeValues = new Dictionary();
private string _filterExpression;
private string _indexName;
private string _keyConditionExpression;
private Dictionary _keyConditions = new Dictionary();
private int? _limit;
private string _projectionExpression;
private Dictionary _queryFilter = new Dictionary();
private ReturnConsumedCapacity _returnConsumedCapacity;
private bool? _scanIndexForward;
private Select _select;
private string _tableName;
///
/// Empty constructor used to set properties independently even when a simple constructor is available
///
public QueryRequest() { }
///
/// Instantiates QueryRequest with the parameterized properties
///
/// The name of the table containing the requested items.
public QueryRequest(string tableName)
{
_tableName = tableName;
}
///
/// Gets and sets the property AttributesToGet.
///
/// This is a legacy parameter. Use ProjectionExpression
instead. For more
/// information, see AttributesToGet
/// in the Amazon DynamoDB Developer Guide.
///
///
[AWSProperty(Min=1)]
public List AttributesToGet
{
get { return this._attributesToGet; }
set { this._attributesToGet = value; }
}
// Check to see if AttributesToGet property is set
internal bool IsSetAttributesToGet()
{
return this._attributesToGet != null && this._attributesToGet.Count > 0;
}
///
/// Gets and sets the property ConditionalOperator.
///
/// This is a legacy parameter. Use FilterExpression
instead. For more information,
/// see ConditionalOperator
/// in the Amazon DynamoDB Developer Guide.
///
///
public ConditionalOperator ConditionalOperator
{
get { return this._conditionalOperator; }
set { this._conditionalOperator = value; }
}
// Check to see if ConditionalOperator property is set
internal bool IsSetConditionalOperator()
{
return this._conditionalOperator != null;
}
///
/// Gets and sets the property 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
.
///
///
public bool ConsistentRead
{
get { return this._consistentRead.GetValueOrDefault(); }
set { this._consistentRead = value; }
}
// Check to see if ConsistentRead property is set
internal bool IsSetConsistentRead()
{
return this._consistentRead.HasValue;
}
///
/// Gets and sets the property 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.
///
///
public Dictionary ExclusiveStartKey
{
get { return this._exclusiveStartKey; }
set { this._exclusiveStartKey = value; }
}
// Check to see if ExclusiveStartKey property is set
internal bool IsSetExclusiveStartKey()
{
return this._exclusiveStartKey != null && this._exclusiveStartKey.Count > 0;
}
///
/// Gets and sets the property ExpressionAttributeNames.
///
/// One or more substitution tokens for attribute names in an expression. The following
/// are some use cases for using ExpressionAttributeNames
:
///
/// -
///
/// To access an attribute whose name conflicts with a DynamoDB reserved word.
///
///
-
///
/// To create a placeholder for repeating occurrences of an attribute name in an expression.
///
///
-
///
/// To prevent special characters in an attribute name from being misinterpreted in an
/// expression.
///
///
///
/// Use the # character in an expression to dereference an attribute name. For
/// example, consider the following attribute name:
///
/// -
///
///
Percentile
///
///
///
/// The name of this attribute conflicts with a reserved word, so it cannot be used directly
/// in an expression. (For the complete list of reserved words, see Reserved
/// Words in the Amazon DynamoDB Developer Guide). To work around this, you
/// could specify the following for ExpressionAttributeNames
:
///
/// -
///
///
{"#P":"Percentile"}
///
///
///
/// You could then use this substitution in an expression, as in this example:
///
/// -
///
///
#P = :val
///
///
///
/// Tokens that begin with the : character are expression attribute values,
/// which are placeholders for the actual value at runtime.
///
///
///
/// For more information on expression attribute names, see Specifying
/// Item Attributes in the Amazon DynamoDB Developer Guide.
///
///
public Dictionary ExpressionAttributeNames
{
get { return this._expressionAttributeNames; }
set { this._expressionAttributeNames = value; }
}
// Check to see if ExpressionAttributeNames property is set
internal bool IsSetExpressionAttributeNames()
{
return this._expressionAttributeNames != null && this._expressionAttributeNames.Count > 0;
}
///
/// Gets and sets the property ExpressionAttributeValues.
///
/// One or more values that can be substituted in an expression.
///
///
///
/// Use the : (colon) character in an expression to dereference an attribute value.
/// For example, suppose that you wanted to check whether the value of the ProductStatus
/// attribute was one of the following:
///
///
///
/// Available | Backordered | Discontinued
///
///
///
/// You would first need to specify ExpressionAttributeValues
as follows:
///
///
///
/// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
/// }
///
///
///
/// You could then use these values in an expression, such as this:
///
///
///
/// ProductStatus IN (:avail, :back, :disc)
///
///
///
/// For more information on expression attribute values, see Specifying
/// Conditions in the Amazon DynamoDB Developer Guide.
///
///
public Dictionary ExpressionAttributeValues
{
get { return this._expressionAttributeValues; }
set { this._expressionAttributeValues = value; }
}
// Check to see if ExpressionAttributeValues property is set
internal bool IsSetExpressionAttributeValues()
{
return this._expressionAttributeValues != null && this._expressionAttributeValues.Count > 0;
}
///
/// Gets and sets the property 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.
///
///
public string FilterExpression
{
get { return this._filterExpression; }
set { this._filterExpression = value; }
}
// Check to see if FilterExpression property is set
internal bool IsSetFilterExpression()
{
return this._filterExpression != null;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Min=3, Max=255)]
public string IndexName
{
get { return this._indexName; }
set { this._indexName = value; }
}
// Check to see if IndexName property is set
internal bool IsSetIndexName()
{
return this._indexName != null;
}
///
/// Gets and sets the property 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.
///
///
public string KeyConditionExpression
{
get { return this._keyConditionExpression; }
set { this._keyConditionExpression = value; }
}
// Check to see if KeyConditionExpression property is set
internal bool IsSetKeyConditionExpression()
{
return this._keyConditionExpression != null;
}
///
/// Gets and sets the property KeyConditions.
///
/// This is a legacy parameter. Use KeyConditionExpression
instead. For more
/// information, see KeyConditions
/// in the Amazon DynamoDB Developer Guide.
///
///
public Dictionary KeyConditions
{
get { return this._keyConditions; }
set { this._keyConditions = value; }
}
// Check to see if KeyConditions property is set
internal bool IsSetKeyConditions()
{
return this._keyConditions != null && this._keyConditions.Count > 0;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Min=1)]
public int Limit
{
get { return this._limit.GetValueOrDefault(); }
set { this._limit = value; }
}
// Check to see if Limit property is set
internal bool IsSetLimit()
{
return this._limit.HasValue;
}
///
/// Gets and sets the property 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.
///
///
public string ProjectionExpression
{
get { return this._projectionExpression; }
set { this._projectionExpression = value; }
}
// Check to see if ProjectionExpression property is set
internal bool IsSetProjectionExpression()
{
return this._projectionExpression != null;
}
///
/// Gets and sets the property QueryFilter.
///
/// This is a legacy parameter. Use FilterExpression
instead. For more information,
/// see QueryFilter
/// in the Amazon DynamoDB Developer Guide.
///
///
public Dictionary QueryFilter
{
get { return this._queryFilter; }
set { this._queryFilter = value; }
}
// Check to see if QueryFilter property is set
internal bool IsSetQueryFilter()
{
return this._queryFilter != null && this._queryFilter.Count > 0;
}
///
/// Gets and sets the property ReturnConsumedCapacity.
///
public ReturnConsumedCapacity ReturnConsumedCapacity
{
get { return this._returnConsumedCapacity; }
set { this._returnConsumedCapacity = value; }
}
// Check to see if ReturnConsumedCapacity property is set
internal bool IsSetReturnConsumedCapacity()
{
return this._returnConsumedCapacity != null;
}
///
/// Gets and sets the property 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.
///
///
public bool ScanIndexForward
{
get { return this._scanIndexForward.GetValueOrDefault(); }
set { this._scanIndexForward = value; }
}
// Check to see if ScanIndexForward property is set
internal bool IsSetScanIndexForward()
{
return this._scanIndexForward.HasValue;
}
///
/// Gets and sets the property Select.
///
/// The attributes to be returned in the result. You can retrieve all item attributes,
/// specific item attributes, the count of matching items, or in the case of an index,
/// some or all of the attributes projected into the index.
///
/// -
///
///
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified
/// table or index. If you query a local secondary index, then for each matching item
/// in the index, DynamoDB fetches the entire item from the parent table. If the index
/// is configured to project all item attributes, then all of the data can be obtained
/// from the local secondary index, and no fetching is required.
///
/// -
///
///
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves
/// all attributes that have been projected into the index. If the index is configured
/// to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES
.
///
/// -
///
///
COUNT
- Returns the number of matching items, rather than the matching
/// items themselves. Note that this uses the same quantity of read capacity units as
/// getting the items, and is subject to the same item size calculations.
///
/// -
///
///
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in ProjectionExpression
.
/// This return value is equivalent to specifying ProjectionExpression
without
/// specifying any value for Select
.
///
///
///
/// If you query or scan a local secondary index and request only attributes that are
/// projected into that index, the operation 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 ProjectionExpression
are specified,
/// DynamoDB defaults to ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
/// when accessing an index. You cannot use both Select
and ProjectionExpression
/// together in a single request, unless the value for Select
is SPECIFIC_ATTRIBUTES
.
/// (This usage is equivalent to specifying ProjectionExpression
without
/// any value for Select
.)
///
///
///
/// If you use the ProjectionExpression
parameter, then the value for Select
/// can only be SPECIFIC_ATTRIBUTES
. Any other value for Select
/// will return an error.
///
///
///
public Select Select
{
get { return this._select; }
set { this._select = value; }
}
// Check to see if Select property is set
internal bool IsSetSelect()
{
return this._select != null;
}
///
/// Gets and sets the property TableName.
///
/// The name of the table containing the requested items.
///
///
[AWSProperty(Required=true, Min=3, Max=255)]
public string TableName
{
get { return this._tableName; }
set { this._tableName = value; }
}
// Check to see if TableName property is set
internal bool IsSetTableName()
{
return this._tableName != null;
}
}
}