ScanDocumentOperationRequest

Initializes a new instance of the Amazon.DynamoDBv2.DocumentModel.ScanDocumentOperationRequest class.

Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty.

Gets or sets the consistent read flag. Strongly consistent reads are only supported for tables and local secondary indexes.

Gets or sets the filter expression specifying which items should be returned after scanning. Applied after DynamoDB reads the items.

Gets or sets the index name to scan against.

Gets or sets the maximum number of items DynamoDB should process before returning a page of results. Defaults to int.MaxValue (service default paging behavior).

Pagination token corresponding to the item where the last Scan operation stopped. Set this value to resume the scan from the next item. Retrieved from a Search object.

Gets or sets the projection expression specifying which attributes should be retrieved.

Controls whether DynamoDB returns capacity consumption details for each Scan request. Defaults to NONE. Set to TOTAL or INDEXES to capture consumed capacity metrics in Search.Metrics.

For parallel Scan requests, Segment identifies an individual segment to be scanned by an application "worker" (such as a thread or a process). Each worker issues a Scan request with a distinct value for the segment it will scan. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on. LastEvaluatedKey returned from a parallel scan request must be used with same Segment id in a subsequent operation. The value for Segment must be less than or equal to 0, and less than the value provided for TotalSegments. If you specify Segment, you must also specify TotalSegments.

Constraints:

   
•         Range         0 - 999999    

Enum specifying what data to return from the scan (e.g., attributes or count).

For parallel Scan requests, TotalSegmentsrepresents the total number of segments for a table that is being scanned. Segments are a way to logically divide a table into equally sized portions, for the duration of the Scan request. The value of TotalSegments corresponds to the number of application "workers" (such as threads or processes) that will perform the parallel Scan. For example, if you want to scan a table using four application threads, you would specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel. If you specify TotalSegments, you must also specify Segment.

Constraints:

   
•         Range         1 - 1000000