com.amazonaws.services.dynamodbv2.model

## クラス ScanResult

- java.lang.Object
- - com.amazonaws.services.dynamodbv2.model.ScanResult

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

      public class ScanResult
      extends java.lang.Object
      implements java.io.Serializable

  Represents the output of a Scan operation.

  関連項目:
    直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `ScanResult` | `addLastEvaluatedKeyEntry(java.lang.String key, AttributeValue value)` The primary key of the item where the operation stopped, inclusive of the previous result set.
    `ScanResult` | `clearLastEvaluatedKeyEntries()` Removes all the entries added into LastEvaluatedKey.
    `boolean` | `equals(java.lang.Object obj)`
    `ConsumedCapacity` | `getConsumedCapacity()` The table name that consumed provisioned throughput, and the number of capacity units consumed by it.
    `java.lang.Integer` | `getCount()` The number of items in the response.
    `java.util.List<java.util.Map<java.lang.String,AttributeValue>>` | `getItems()` An array of item attributes that match the scan criteria.
    `java.util.Map<java.lang.String,AttributeValue>` | `getLastEvaluatedKey()` The primary key of the item where the operation stopped, inclusive of the previous result set.
    `java.lang.Integer` | `getScannedCount()` The number of items in the complete scan, before any filters are applied.
    `int` | `hashCode()`
    `void` | `setConsumedCapacity(ConsumedCapacity consumedCapacity)` The table name that consumed provisioned throughput, and the number of capacity units consumed by it.
    `void` | `setCount(java.lang.Integer count)` The number of items in the response.
    `void` | `setItems(java.util.Collection<java.util.Map<java.lang.String,AttributeValue>> items)` An array of item attributes that match the scan criteria.
    `void` | `setLastEvaluatedKey(java.util.Map<java.lang.String,AttributeValue> lastEvaluatedKey)` The primary key of the item where the operation stopped, inclusive of the previous result set.
    `void` | `setScannedCount(java.lang.Integer scannedCount)` The number of items in the complete scan, before any filters are applied.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `ScanResult` | `withConsumedCapacity(ConsumedCapacity consumedCapacity)` The table name that consumed provisioned throughput, and the number of capacity units consumed by it.
    `ScanResult` | `withCount(java.lang.Integer count)` The number of items in the response.
    `ScanResult` | `withItems(java.util.Collection<java.util.Map<java.lang.String,AttributeValue>> items)` An array of item attributes that match the scan criteria.
    `ScanResult` | `withItems(java.util.Map<java.lang.String,AttributeValue>... items)` An array of item attributes that match the scan criteria.
    `ScanResult` | `withLastEvaluatedKey(java.util.Map<java.lang.String,AttributeValue> lastEvaluatedKey)` The primary key of the item where the operation stopped, inclusive of the previous result set.
    `ScanResult` | `withScannedCount(java.lang.Integer scannedCount)` The number of items in the complete scan, before any filters are applied.

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

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

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

    - #### ScanResult

          public ScanResult()

  - ### メソッドの詳細

    - #### getItems

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

      An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
      戻り値:
        An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

    - #### setItems

          public void setItems(java.util.Collection<java.util.Map<java.lang.String,AttributeValue>> items)

      An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
      パラメータ:
        `items` - An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

    - #### withItems

          public ScanResult withItems(java.util.Map<java.lang.String,AttributeValue>... items)

      An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

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

      パラメータ:
        `items` - An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

    - #### withItems

          public ScanResult withItems(java.util.Collection<java.util.Map<java.lang.String,AttributeValue>> items)

      An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

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

      パラメータ:
        `items` - An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

    - #### getCount

          public java.lang.Integer getCount()

      The number of items in the response.
      戻り値:
        The number of items in the response.

    - #### setCount

          public void setCount(java.lang.Integer count)

      The number of items in the response.
      パラメータ:
        `count` - The number of items in the response.

    - #### withCount

          public ScanResult withCount(java.lang.Integer count)

      The number of items in the response.

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

      パラメータ:
        `count` - The number of items in the response.

    - #### getScannedCount

          public java.lang.Integer getScannedCount()

      The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
      戻り値:
        The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

    - #### setScannedCount

          public void setScannedCount(java.lang.Integer scannedCount)

      The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
      パラメータ:
        `scannedCount` - The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

    - #### withScannedCount

          public ScanResult withScannedCount(java.lang.Integer scannedCount)

      The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

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

      パラメータ:
        `scannedCount` - The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

    - #### getLastEvaluatedKey

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

      The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

      LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

      If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

      戻り値:
        The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

        LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

        If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

    - #### setLastEvaluatedKey

          public void setLastEvaluatedKey(java.util.Map<java.lang.String,AttributeValue> lastEvaluatedKey)

      The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

      LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

      If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

      パラメータ:
        `lastEvaluatedKey` - The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

        LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

        If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

    - #### withLastEvaluatedKey

          public ScanResult withLastEvaluatedKey(java.util.Map<java.lang.String,AttributeValue> lastEvaluatedKey)

      The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

      LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

      If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

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

      パラメータ:
        `lastEvaluatedKey` - The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

        LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

        If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

    - #### addLastEvaluatedKeyEntry

          public ScanResult addLastEvaluatedKeyEntry(java.lang.String key,
                                            AttributeValue value)

      The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

      LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

      If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

      The method adds a new key-value pair into LastEvaluatedKey parameter, and returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `key` - The key of the entry to be added into LastEvaluatedKey.
        `value` - The corresponding value of the entry to be added into LastEvaluatedKey.

    - #### clearLastEvaluatedKeyEntries

          public ScanResult clearLastEvaluatedKeyEntries()

      Removes all the entries added into LastEvaluatedKey.

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

    - #### getConsumedCapacity

          public ConsumedCapacity getConsumedCapacity()

      The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
      戻り値:
        The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

    - #### setConsumedCapacity

          public void setConsumedCapacity(ConsumedCapacity consumedCapacity)

      The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
      パラメータ:
        `consumedCapacity` - The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

    - #### withConsumedCapacity

          public ScanResult withConsumedCapacity(ConsumedCapacity consumedCapacity)

      The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

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

      パラメータ:
        `consumedCapacity` - The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

    - #### 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`