com.amazonaws.services.dynamodb.model

## クラス QueryRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.dynamodb.model.QueryRequest

- すべての実装されたインタフェース:
    java.io.Serializable

  非推奨です。

      @Deprecated
      public class QueryRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `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.

  関連項目:
    `AmazonDynamoDB.query(QueryRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `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.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### QueryRequest

          public QueryRequest()

      非推奨です。
      Default constructor for a new QueryRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

    - #### QueryRequest

          public QueryRequest(java.lang.String tableName,
                      AttributeValue hashKeyValue)

      非推奨です。
      Constructs a new QueryRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `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.

  - ### メソッドの詳細

    - #### getTableName

          public java.lang.String getTableName()

      非推奨です。
      The name of the table in which you want to query. Allowed characters are `a-z`, `A-Z`, `0-9`, `_` (underscore), `-` (hyphen) and `.` (period).

      Constraints:
      Length: 3 - 255
      Pattern: [a-zA-Z0-9_.-]+

      戻り値:
        The name of the table in which you want to query. Allowed characters are `a-z`, `A-Z`, `0-9`, `_` (underscore), `-` (hyphen) and `.` (period).

    - #### setTableName

          public void setTableName(java.lang.String 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).

      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).

    - #### withTableName

          public QueryRequest withTableName(java.lang.String 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).

      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).
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### getAttributesToGet

          public java.util.List<java.lang.String> getAttributesToGet()

      非推奨です。
      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.

      Constraints:
      Length: 1 -

      戻り値:
        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.

    - #### setAttributesToGet

          public void setAttributesToGet(java.util.Collection<java.lang.String> 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.

      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.

    - #### withAttributesToGet

          public QueryRequest withAttributesToGet(java.lang.String... 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.

      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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### withAttributesToGet

          public QueryRequest withAttributesToGet(java.util.Collection<java.lang.String> 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.

      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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### getLimit

          public java.lang.Integer getLimit()

      非推奨です。
      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.

      Constraints:
      Range: 1 -

      戻り値:
        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.

    - #### setLimit

          public void setLimit(java.lang.Integer 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.

      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.

    - #### withLimit

          public QueryRequest withLimit(java.lang.Integer 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.

      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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### isConsistentRead

          public java.lang.Boolean isConsistentRead()

      非推奨です。
      If set to `true`, then a consistent read is issued. Otherwise eventually-consistent is used.
      戻り値:
        If set to `true`, then a consistent read is issued. Otherwise eventually-consistent is used.

    - #### setConsistentRead

          public void setConsistentRead(java.lang.Boolean consistentRead)

      非推奨です。
      If set to `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.

    - #### withConsistentRead

          public QueryRequest withConsistentRead(java.lang.Boolean consistentRead)

      非推奨です。
      If set to `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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### getConsistentRead

          public java.lang.Boolean getConsistentRead()

      非推奨です。
      If set to `true`, then a consistent read is issued. Otherwise eventually-consistent is used.
      戻り値:
        If set to `true`, then a consistent read is issued. Otherwise eventually-consistent is used.

    - #### isCount

          public 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. Do not set `Count` to `true` while providing a list of `AttributesToGet`, otherwise Amazon DynamoDB returns a validation error.
      戻り値:
        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.

    - #### setCount

          public 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. 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.

    - #### withCount

          public 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. 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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### getCount

          public 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. Do not set `Count` to `true` while providing a list of `AttributesToGet`, otherwise Amazon DynamoDB returns a validation error.
      戻り値:
        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.

    - #### getHashKeyValue

          public AttributeValue getHashKeyValue()

      非推奨です。
      Attribute value of the hash component of the composite primary key.
      戻り値:
        Attribute value of the hash component of the composite primary key.

    - #### setHashKeyValue

          public void setHashKeyValue(AttributeValue hashKeyValue)

      非推奨です。
      Attribute value of the hash component of the composite primary key.
      パラメータ:
        `hashKeyValue` - Attribute value of the hash component of the composite primary key.

    - #### withHashKeyValue

          public QueryRequest withHashKeyValue(AttributeValue hashKeyValue)

      非推奨です。
      Attribute value of the hash component of the composite primary key.

      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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### getRangeKeyCondition

          public Condition getRangeKeyCondition()

      非推奨です。
      A container for the attribute values and comparison operators to use for the query.
      戻り値:
        A container for the attribute values and comparison operators to use for the query.

    - #### setRangeKeyCondition

          public void setRangeKeyCondition(Condition rangeKeyCondition)

      非推奨です。
      A container for the attribute values and comparison operators to use for the query.
      パラメータ:
        `rangeKeyCondition` - A container for the attribute values and comparison operators to use for the query.

    - #### withRangeKeyCondition

          public QueryRequest withRangeKeyCondition(Condition rangeKeyCondition)

      非推奨です。
      A container for the attribute values and comparison operators to use for the query.

      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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### isScanIndexForward

          public java.lang.Boolean isScanIndexForward()

      非推奨です。
      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).
      戻り値:
        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).

    - #### setScanIndexForward

          public void setScanIndexForward(java.lang.Boolean 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).
      パラメータ:
        `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).

    - #### withScanIndexForward

          public QueryRequest withScanIndexForward(java.lang.Boolean 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).

      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).
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### getScanIndexForward

          public java.lang.Boolean getScanIndexForward()

      非推奨です。
      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).
      戻り値:
        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).

    - #### getExclusiveStartKey

          public Key getExclusiveStartKey()

      非推奨です。
      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.
      戻り値:
        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.

    - #### setExclusiveStartKey

          public void setExclusiveStartKey(Key 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.
      パラメータ:
        `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.

    - #### withExclusiveStartKey

          public QueryRequest withExclusiveStartKey(Key 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.

      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.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### toString

          public java.lang.String toString()

      非推奨です。
      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      非推奨です。
      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      非推奨です。
      オーバーライド:
        `equals` クラス内 `java.lang.Object`