com.amazonaws.services.dynamodbv2.datamodeling

## クラス DynamoDBScanExpression

- java.lang.Object
- - com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBScanExpression

-     public class DynamoDBScanExpression
      extends java.lang.Object

  Options for filtering results from a scan operation. For example, callers can specify filter conditions so that only objects whose attributes match different conditions are returned (see `ComparisonOperator` for more information on the available comparison types).
  関連項目:
    `DynamoDBMapper.scan(Class, DynamoDBScanExpression)`

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

    コンストラクタ
    コンストラクタと説明
    `DynamoDBScanExpression()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addFilterCondition(java.lang.String attributeName, Condition condition)` Adds a new filter condition to the current scan filter.
    `java.util.Map<java.lang.String,AttributeValue>` | `getExclusiveStartKey()` Returns the exclusive start key for this scan.
    `java.lang.Integer` | `getLimit()` Returns the limit of items to scan during this scan.
    `java.util.Map<java.lang.String,Condition>` | `getScanFilter()` Returns the scan filter as a map of attribute names to conditions.
    `void` | `setExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)` Sets the exclusive start key for this scan.
    `void` | `setLimit(java.lang.Integer limit)` Sets the limit of items to scan during this scan.
    `void` | `setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)` Sets the scan filter to the map of attribute names to conditions given.
    `DynamoDBScanExpression` | `withExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)` Sets the exclusive start key for this scan and returns a pointer to this object for method-chaining.
    `DynamoDBScanExpression` | `withLimit(java.lang.Integer limit)` Sets the limit of items to scan and returns a pointer to this object for method-chaining.

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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

    - #### DynamoDBScanExpression

          public DynamoDBScanExpression()

  - ### メソッドの詳細

    - #### setScanFilter

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

      Sets the scan filter to the map of attribute names to conditions given.
      パラメータ:
        `scanFilter` - The map of attribute names to conditions to use when filtering scan results.

    - #### getScanFilter

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

      Returns the scan filter as a map of attribute names to conditions.
      戻り値:
        The scan filter as a map of attribute names to conditions.

    - #### addFilterCondition

          public void addFilterCondition(java.lang.String attributeName,
                                Condition condition)

      Adds a new filter condition to the current scan filter.
      パラメータ:
        `attributeName` - The name of the attribute on which the specified condition operates.
        `condition` - The condition which describes how the specified attribute is compared and if a row of data is included in the results returned by the scan operation.

    - #### getExclusiveStartKey

          public java.util.Map<java.lang.String,AttributeValue> getExclusiveStartKey()

      Returns the exclusive start key for this scan.

    - #### setExclusiveStartKey

          public void setExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)

      Sets the exclusive start key for this scan.

    - #### withExclusiveStartKey

          public DynamoDBScanExpression withExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)

      Sets the exclusive start key for this scan and returns a pointer to this object for method-chaining.

    - #### getLimit

          public java.lang.Integer getLimit()

      Returns the limit of items to scan during this scan.

      Use with caution. Please note that this is not the same as the number of items to return from the scan operation -- the operation will cease and return as soon as this many items are scanned, even if no matching results are found. Furthermore, `PaginatedScanList` will execute as many scan operations as necessary until it either reaches the end of the result set as indicated by DynamoDB or enough elements are available to fulfill the list operation (e.g. iteration). Therefore, except when scanning without a scan filter, it's usually bad practice to set a low limit, since doing so will often generate the same amount of traffic to DynamoDB but with a greater number of round trips and therefore more overall latency.

    - #### setLimit

          public void setLimit(java.lang.Integer limit)

      Sets the limit of items to scan during this scan. Please note that this is not the same as the number of items to return from the scan operation -- the operation will cease and return as soon as this many items are scanned, even if no matching results are found.
      関連項目:
        `getLimit()`

    - #### withLimit

          public DynamoDBScanExpression withLimit(java.lang.Integer limit)

      Sets the limit of items to scan and returns a pointer to this object for method-chaining. Please note that this is not the same as the number of items to return from the scan operation -- the operation will cease and return as soon as this many items are scanned, even if no matching results are found.
      関連項目:
        `getLimit()`