@Deprecated public class QueryRequest extends AmazonWebServiceRequest implements java.io.Serializable
Query operation.
Gets the values of one or more items and its attributes by primary key (composite primary key, only).
Narrow the scope of the query using comparison operators on the RangeKeyValue of the composite key. Use the ScanIndexForward
parameter to get results in forward or reverse order by range key.
| コンストラクタと説明 |
|---|
QueryRequest()
非推奨です。
Default constructor for a new QueryRequest object.
|
QueryRequest(java.lang.String tableName,
AttributeValue hashKeyValue)
非推奨です。
Constructs a new QueryRequest object.
|
| 修飾子とタイプ | メソッドと説明 |
|---|---|
boolean |
equals(java.lang.Object obj)
非推奨です。
|
java.util.List<java.lang.String> |
getAttributesToGet()
非推奨です。
List of
Attribute names. |
java.lang.Boolean |
getConsistentRead()
非推奨です。
If set to
true, then a consistent read is issued. |
java.lang.Boolean |
getCount()
非推奨です。
If set to
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. |
Key |
getExclusiveStartKey()
非推奨です。
Primary key of the item from which to continue an earlier query.
|
AttributeValue |
getHashKeyValue()
非推奨です。
Attribute value of the hash component of the composite primary key.
|
java.lang.Integer |
getLimit()
非推奨です。
The maximum number of items to return.
|
Condition |
getRangeKeyCondition()
非推奨です。
A container for the attribute values and comparison operators to use
for the query.
|
java.lang.Boolean |
getScanIndexForward()
非推奨です。
Specifies forward or backward traversal of the index.
|
java.lang.String |
getTableName()
非推奨です。
The name of the table in which you want to query.
|
int |
hashCode()
非推奨です。
|
java.lang.Boolean |
isConsistentRead()
非推奨です。
If set to
true, then a consistent read is issued. |
java.lang.Boolean |
isCount()
非推奨です。
If set to
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. |
java.lang.Boolean |
isScanIndexForward()
非推奨です。
Specifies forward or backward traversal of the index.
|
void |
setAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
非推奨です。
List of
Attribute names. |
void |
setConsistentRead(java.lang.Boolean consistentRead)
非推奨です。
If set to
true, then a consistent read is issued. |
void |
setCount(java.lang.Boolean count)
非推奨です。
If set to
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. |
void |
setExclusiveStartKey(Key exclusiveStartKey)
非推奨です。
Primary key of the item from which to continue an earlier query.
|
void |
setHashKeyValue(AttributeValue hashKeyValue)
非推奨です。
Attribute value of the hash component of the composite primary key.
|
void |
setLimit(java.lang.Integer limit)
非推奨です。
The maximum number of items to return.
|
void |
setRangeKeyCondition(Condition rangeKeyCondition)
非推奨です。
A container for the attribute values and comparison operators to use
for the query.
|
void |
setScanIndexForward(java.lang.Boolean scanIndexForward)
非推奨です。
Specifies forward or backward traversal of the index.
|
void |
setTableName(java.lang.String tableName)
非推奨です。
The name of the table in which you want to query.
|
java.lang.String |
toString()
非推奨です。
Returns a string representation of this object; useful for testing and
debugging.
|
QueryRequest |
withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
非推奨です。
List of
Attribute names. |
QueryRequest |
withAttributesToGet(java.lang.String... attributesToGet)
非推奨です。
List of
Attribute names. |
QueryRequest |
withConsistentRead(java.lang.Boolean consistentRead)
非推奨です。
If set to
true, then a consistent read is issued. |
QueryRequest |
withCount(java.lang.Boolean count)
非推奨です。
If set to
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. |
QueryRequest |
withExclusiveStartKey(Key exclusiveStartKey)
非推奨です。
Primary key of the item from which to continue an earlier query.
|
QueryRequest |
withHashKeyValue(AttributeValue hashKeyValue)
非推奨です。
Attribute value of the hash component of the composite primary key.
|
QueryRequest |
withLimit(java.lang.Integer limit)
非推奨です。
The maximum number of items to return.
|
QueryRequest |
withRangeKeyCondition(Condition rangeKeyCondition)
非推奨です。
A container for the attribute values and comparison operators to use
for the query.
|
QueryRequest |
withScanIndexForward(java.lang.Boolean scanIndexForward)
非推奨です。
Specifies forward or backward traversal of the index.
|
QueryRequest |
withTableName(java.lang.String tableName)
非推奨です。
The name of the table in which you want to query.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentialspublic QueryRequest()
public QueryRequest(java.lang.String tableName,
AttributeValue hashKeyValue)
tableName - The name of the table in which you want to query.
Allowed characters are a-z, A-Z,
0-9, _ (underscore), - (hyphen)
and . (period).hashKeyValue - Attribute value of the hash component of the
composite primary key.public java.lang.String getTableName()
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).public void setTableName(java.lang.String tableName)
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName - The name of the table in which you want to query. Allowed characters
are a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).public QueryRequest withTableName(java.lang.String tableName)
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName - The name of the table in which you want to query. Allowed characters
are a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).public java.util.List<java.lang.String> getAttributesToGet()
Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Constraints:
Length: 1 -
Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.public void setAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Constraints:
Length: 1 -
attributesToGet - List of Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.public QueryRequest withAttributesToGet(java.lang.String... attributesToGet)
Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet - List of Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.public QueryRequest withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet - List of Attribute names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.public java.lang.Integer getLimit()
LastEvaluatedKey
to apply in a subsequent operation to continue the query. Also, if the
result set size exceeds 1MB before Amazon DynamoDB hits this limit, it
stops the query and returns the matching values, and a
LastEvaluatedKey to apply in a subsequent operation to
continue the query.
Constraints:
Range: 1 -
LastEvaluatedKey
to apply in a subsequent operation to continue the query. Also, if the
result set size exceeds 1MB before Amazon DynamoDB hits this limit, it
stops the query and returns the matching values, and a
LastEvaluatedKey to apply in a subsequent operation to
continue the query.public void setLimit(java.lang.Integer limit)
LastEvaluatedKey
to apply in a subsequent operation to continue the query. Also, if the
result set size exceeds 1MB before Amazon DynamoDB hits this limit, it
stops the query and returns the matching values, and a
LastEvaluatedKey to apply in a subsequent operation to
continue the query.
Constraints:
Range: 1 -
limit - The maximum number of items to return. If Amazon DynamoDB hits this
limit while querying the table, it stops the query and returns the
matching values up to the limit, and a LastEvaluatedKey
to apply in a subsequent operation to continue the query. Also, if the
result set size exceeds 1MB before Amazon DynamoDB hits this limit, it
stops the query and returns the matching values, and a
LastEvaluatedKey to apply in a subsequent operation to
continue the query.public QueryRequest withLimit(java.lang.Integer limit)
LastEvaluatedKey
to apply in a subsequent operation to continue the query. Also, if the
result set size exceeds 1MB before Amazon DynamoDB hits this limit, it
stops the query and returns the matching values, and a
LastEvaluatedKey to apply in a subsequent operation to
continue the query.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
limit - The maximum number of items to return. If Amazon DynamoDB hits this
limit while querying the table, it stops the query and returns the
matching values up to the limit, and a LastEvaluatedKey
to apply in a subsequent operation to continue the query. Also, if the
result set size exceeds 1MB before Amazon DynamoDB hits this limit, it
stops the query and returns the matching values, and a
LastEvaluatedKey to apply in a subsequent operation to
continue the query.public java.lang.Boolean isConsistentRead()
true, then a consistent read is issued.
Otherwise eventually-consistent is used.true, then a consistent read is issued.
Otherwise eventually-consistent is used.public void setConsistentRead(java.lang.Boolean consistentRead)
true, then a consistent read is issued.
Otherwise eventually-consistent is used.consistentRead - If set to true, then a consistent read is issued.
Otherwise eventually-consistent is used.public QueryRequest withConsistentRead(java.lang.Boolean consistentRead)
true, then a consistent read is issued.
Otherwise eventually-consistent is used.
Returns a reference to this object so that method calls can be chained together.
consistentRead - If set to true, then a consistent read is issued.
Otherwise eventually-consistent is used.public java.lang.Boolean getConsistentRead()
true, then a consistent read is issued.
Otherwise eventually-consistent is used.true, then a consistent read is issued.
Otherwise eventually-consistent is used.public java.lang.Boolean isCount()
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.public void setCount(java.lang.Boolean count)
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.count - If set to true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.public QueryRequest withCount(java.lang.Boolean count)
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.
Returns a reference to this object so that method calls can be chained together.
count - If set to true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.public java.lang.Boolean getCount()
true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.true, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count to
true while providing a list of
AttributesToGet, otherwise Amazon DynamoDB returns a
validation error.public AttributeValue getHashKeyValue()
public void setHashKeyValue(AttributeValue hashKeyValue)
hashKeyValue - Attribute value of the hash component of the composite primary key.public QueryRequest withHashKeyValue(AttributeValue hashKeyValue)
Returns a reference to this object so that method calls can be chained together.
hashKeyValue - Attribute value of the hash component of the composite primary key.public Condition getRangeKeyCondition()
public void setRangeKeyCondition(Condition rangeKeyCondition)
rangeKeyCondition - A container for the attribute values and comparison operators to use
for the query.public QueryRequest withRangeKeyCondition(Condition rangeKeyCondition)
Returns a reference to this object so that method calls can be chained together.
rangeKeyCondition - A container for the attribute values and comparison operators to use
for the query.public java.lang.Boolean isScanIndexForward()
true (forward).true (forward).public void setScanIndexForward(java.lang.Boolean scanIndexForward)
true (forward).scanIndexForward - Specifies forward or backward traversal of the index. Amazon DynamoDB
returns results reflecting the requested order, determined by the
range key. The default value is true (forward).public QueryRequest withScanIndexForward(java.lang.Boolean scanIndexForward)
true (forward).
Returns a reference to this object so that method calls can be chained together.
scanIndexForward - Specifies forward or backward traversal of the index. Amazon DynamoDB
returns results reflecting the requested order, determined by the
range key. The default value is true (forward).public java.lang.Boolean getScanIndexForward()
true (forward).true (forward).public Key getExclusiveStartKey()
LastEvaluatedKey if that query operation was interrupted
before completing the query; either because of the result set size or
the Limit parameter. The LastEvaluatedKey
can be passed back in a new query request to continue the operation
from that point.LastEvaluatedKey if that query operation was interrupted
before completing the query; either because of the result set size or
the Limit parameter. The LastEvaluatedKey
can be passed back in a new query request to continue the operation
from that point.public void setExclusiveStartKey(Key exclusiveStartKey)
LastEvaluatedKey if that query operation was interrupted
before completing the query; either because of the result set size or
the Limit parameter. The LastEvaluatedKey
can be passed back in a new query request to continue the operation
from that point.exclusiveStartKey - Primary key of the item from which to continue an earlier query. An
earlier query might provide this value as the
LastEvaluatedKey if that query operation was interrupted
before completing the query; either because of the result set size or
the Limit parameter. The LastEvaluatedKey
can be passed back in a new query request to continue the operation
from that point.public QueryRequest withExclusiveStartKey(Key exclusiveStartKey)
LastEvaluatedKey if that query operation was interrupted
before completing the query; either because of the result set size or
the Limit parameter. The LastEvaluatedKey
can be passed back in a new query request to continue the operation
from that point.
Returns a reference to this object so that method calls can be chained together.
exclusiveStartKey - Primary key of the item from which to continue an earlier query. An
earlier query might provide this value as the
LastEvaluatedKey if that query operation was interrupted
before completing the query; either because of the result set size or
the Limit parameter. The LastEvaluatedKey
can be passed back in a new query request to continue the operation
from that point.public java.lang.String toString()
toString クラス内 java.lang.ObjectObject.toString()public int hashCode()
hashCode クラス内 java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals クラス内 java.lang.Object