Struct aws_sdk_dynamodb::operation::scan::builders::ScanOutputBuilder

#[non_exhaustive]
pub struct ScanOutputBuilder { /* private fields */ }

A builder for ScanOutput.

Implementations

impl ScanOutputBuilder

pub fn items(self, input: HashMap<String, AttributeValue>) -> Self

Appends an item to items.

To override the contents of this collection use set_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.

pub fn set_items( self, input: Option<Vec<HashMap<String, AttributeValue>>>, ) -> Self

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.

pub fn get_items(&self) -> &Option<Vec<HashMap<String, AttributeValue>>>

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.

pub fn count(self, input: i32) -> Self

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

pub fn set_count(self, input: Option<i32>) -> Self

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

pub fn get_count(&self) -> &Option<i32>

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

pub fn scanned_count(self, input: i32) -> Self

The number of items evaluated, before any ScanFilter is 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.

If you did not use a filter in the request, then ScannedCount is the same as Count.

pub fn set_scanned_count(self, input: Option<i32>) -> Self

The number of items evaluated, before any ScanFilter is 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.

If you did not use a filter in the request, then ScannedCount is the same as Count.

pub fn get_scanned_count(&self) -> &Option<i32>

The number of items evaluated, before any ScanFilter is 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.

If you did not use a filter in the request, then ScannedCount is the same as Count.

pub fn last_evaluated_key(self, k: impl Into<String>, v: AttributeValue) -> Self

Adds a key-value pair to last_evaluated_key.

To override the contents of this collection use set_last_evaluated_key.

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.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

pub fn set_last_evaluated_key( self, input: Option<HashMap<String, AttributeValue>>, ) -> Self

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.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

pub fn get_last_evaluated_key(&self) -> &Option<HashMap<String, AttributeValue>>

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.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

pub fn consumed_capacity(self, input: ConsumedCapacity) -> Self

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

pub fn set_consumed_capacity(self, input: Option<ConsumedCapacity>) -> Self

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

pub fn get_consumed_capacity(&self) -> &Option<ConsumedCapacity>

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

pub fn build(self) -> ScanOutput

Consumes the builder and constructs a ScanOutput.

Trait Implementations

impl Clone for ScanOutputBuilder

fn clone(&self) -> ScanOutputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScanOutputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScanOutputBuilder

fn default() -> ScanOutputBuilder

Returns the “default value” for a type.

impl PartialEq for ScanOutputBuilder

fn eq(&self, other: &ScanOutputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScanOutputBuilder