com.amazonaws.services.dynamodb.model

## クラス ScanRequest

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

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

  非推奨です。

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

  Container for the parameters to the `Scan operation`.

  Retrieves one or more items and its attributes by performing a full scan of a table.

  Provide a `ScanFilter` to get more specific results.

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

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

    コンストラクタ
    コンストラクタと説明
    `ScanRequest()` 非推奨です。 Default constructor for a new ScanRequest object.
    `ScanRequest(java.lang.String tableName)` 非推奨です。 Constructs a new ScanRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)` 非推奨です。
    `java.util.List<java.lang.String>` | `getAttributesToGet()` 非推奨です。 List of `Attribute` names.
    `java.lang.Boolean` | `getCount()` 非推奨です。 If set to `true`, Amazon DynamoDB returns a total number of items for the `Scan` operation, even if the operation has no matching items for the assigned filter.
    `Key` | `getExclusiveStartKey()` 非推奨です。 Primary key of the item from which to continue an earlier scan.
    `java.lang.Integer` | `getLimit()` 非推奨です。 The maximum number of items to return.
    `java.util.Map<java.lang.String,Condition>` | `getScanFilter()` 非推奨です。 Evaluates the scan results and returns only the desired values.
    `java.lang.String` | `getTableName()` 非推奨です。 The name of the table in which you want to scan.
    `int` | `hashCode()` 非推奨です。
    `java.lang.Boolean` | `isCount()` 非推奨です。 If set to `true`, Amazon DynamoDB returns a total number of items for the `Scan` operation, even if the operation has no matching items for the assigned filter.
    `void` | `setAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)` 非推奨です。 List of `Attribute` names.
    `void` | `setCount(java.lang.Boolean count)` 非推奨です。 If set to `true`, Amazon DynamoDB returns a total number of items for the `Scan` operation, even if the operation has no matching items for the assigned filter.
    `void` | `setExclusiveStartKey(Key exclusiveStartKey)` 非推奨です。 Primary key of the item from which to continue an earlier scan.
    `void` | `setLimit(java.lang.Integer limit)` 非推奨です。 The maximum number of items to return.
    `void` | `setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)` 非推奨です。 Evaluates the scan results and returns only the desired values.
    `void` | `setTableName(java.lang.String tableName)` 非推奨です。 The name of the table in which you want to scan.
    `java.lang.String` | `toString()` 非推奨です。 Returns a string representation of this object; useful for testing and debugging.
    `ScanRequest` | `withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)` 非推奨です。 List of `Attribute` names.
    `ScanRequest` | `withAttributesToGet(java.lang.String... attributesToGet)` 非推奨です。 List of `Attribute` names.
    `ScanRequest` | `withCount(java.lang.Boolean count)` 非推奨です。 If set to `true`, Amazon DynamoDB returns a total number of items for the `Scan` operation, even if the operation has no matching items for the assigned filter.
    `ScanRequest` | `withExclusiveStartKey(Key exclusiveStartKey)` 非推奨です。 Primary key of the item from which to continue an earlier scan.
    `ScanRequest` | `withLimit(java.lang.Integer limit)` 非推奨です。 The maximum number of items to return.
    `ScanRequest` | `withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)` 非推奨です。 Evaluates the scan results and returns only the desired values.
    `ScanRequest` | `withTableName(java.lang.String tableName)` 非推奨です。 The name of the table in which you want to scan.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### ScanRequest

          public ScanRequest()

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

    - #### ScanRequest

          public ScanRequest(java.lang.String tableName)

      非推奨です。
      Constructs a new ScanRequest 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 scan. Allowed characters are `a-z`, `A-Z`, `0-9`, `_` (underscore), `-` (hyphen) and `.` (period).

  - ### メソッドの詳細

    - #### getTableName

          public java.lang.String getTableName()

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

    - #### withTableName

          public ScanRequest withTableName(java.lang.String tableName)

      非推奨です。
      The name of the table in which you want to scan. 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 scan. 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 ScanRequest 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 ScanRequest 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 scanning the table, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan.

      Constraints:
      Range: 1 -

      戻り値:
        The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan.

    - #### setLimit

          public void setLimit(java.lang.Integer limit)

      非推奨です。
      The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan.

      Constraints:
      Range: 1 -

      パラメータ:
        `limit` - The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan.

    - #### withLimit

          public ScanRequest withLimit(java.lang.Integer limit)

      非推奨です。
      The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan.

      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 scanning the table, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a `LastEvaluatedKey` to apply in a subsequent operation to continue the scan.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### isCount

          public java.lang.Boolean isCount()

      非推奨です。
      If set to `true`, Amazon DynamoDB returns a total number of items for the `Scan` operation, even if the operation has no matching items for the assigned filter. 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 for the `Scan` operation, even if the operation has no matching items for the assigned filter. 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 for the `Scan` operation, even if the operation has no matching items for the assigned filter. 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 for the `Scan` operation, even if the operation has no matching items for the assigned filter. Do not set `Count` to `true` while providing a list of `AttributesToGet`, otherwise Amazon DynamoDB returns a validation error.

    - #### withCount

          public ScanRequest withCount(java.lang.Boolean count)

      非推奨です。
      If set to `true`, Amazon DynamoDB returns a total number of items for the `Scan` operation, even if the operation has no matching items for the assigned filter. 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 for the `Scan` operation, even if the operation has no matching items for the assigned filter. 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 for the `Scan` operation, even if the operation has no matching items for the assigned filter. 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 for the `Scan` operation, even if the operation has no matching items for the assigned filter. Do not set `Count` to `true` while providing a list of `AttributesToGet`, otherwise Amazon DynamoDB returns a validation error.

    - #### getScanFilter

          public java.util.Map<java.lang.String,Condition> getScanFilter()

      非推奨です。
      Evaluates the scan results and returns only the desired values.
      戻り値:
        Evaluates the scan results and returns only the desired values.

    - #### setScanFilter

          public void setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)

      非推奨です。
      Evaluates the scan results and returns only the desired values.
      パラメータ:
        `scanFilter` - Evaluates the scan results and returns only the desired values.

    - #### withScanFilter

          public ScanRequest withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)

      非推奨です。
      Evaluates the scan results and returns only the desired values.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `scanFilter` - Evaluates the scan results and returns only the desired values.
      戻り値:
        A reference to this updated object so that method calls can be chained together.

    - #### getExclusiveStartKey

          public Key getExclusiveStartKey()

      非推奨です。
      Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the `Limit` parameter. The `LastEvaluatedKey` can be passed back in a new scan request to continue the operation from that point.
      戻り値:
        Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the `Limit` parameter. The `LastEvaluatedKey` can be passed back in a new scan 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 scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the `Limit` parameter. The `LastEvaluatedKey` can be passed back in a new scan request to continue the operation from that point.
      パラメータ:
        `exclusiveStartKey` - Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the `Limit` parameter. The `LastEvaluatedKey` can be passed back in a new scan request to continue the operation from that point.

    - #### withExclusiveStartKey

          public ScanRequest withExclusiveStartKey(Key exclusiveStartKey)

      非推奨です。
      Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the `Limit` parameter. The `LastEvaluatedKey` can be passed back in a new scan 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 scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the `Limit` parameter. The `LastEvaluatedKey` can be passed back in a new scan 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`