Struct aws_sdk_dynamodb::operation::batch_get_item::builders::BatchGetItemOutputBuilder

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

A builder for BatchGetItemOutput.

Implementations

impl BatchGetItemOutputBuilder

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

Adds a key-value pair to responses.

To override the contents of this collection use set_responses.

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

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

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

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

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

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

Adds a key-value pair to unprocessed_keys.

To override the contents of this collection use set_unprocessed_keys.

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

• Keys - An array of primary key attribute values that define specific items in the table.

• ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

• ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

pub fn set_unprocessed_keys( self, input: Option<HashMap<String, KeysAndAttributes>> ) -> Self

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

• Keys - An array of primary key attribute values that define specific items in the table.

• ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

• ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

pub fn get_unprocessed_keys( &self ) -> &Option<HashMap<String, KeysAndAttributes>>

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

• Keys - An array of primary key attribute values that define specific items in the table.

• ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

• ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

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

Appends an item to consumed_capacity.

To override the contents of this collection use set_consumed_capacity.

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

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

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

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

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

pub fn build(self) -> BatchGetItemOutput

Consumes the builder and constructs a BatchGetItemOutput.

Trait Implementations

impl Clone for BatchGetItemOutputBuilder

fn clone(&self) -> BatchGetItemOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchGetItemOutputBuilder

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

Formats the value using the given formatter.

impl Default for BatchGetItemOutputBuilder

fn default() -> BatchGetItemOutputBuilder

Returns the “default value” for a type.

impl PartialEq for BatchGetItemOutputBuilder

fn eq(&self, other: &BatchGetItemOutputBuilder) -> 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 BatchGetItemOutputBuilder