#[non_exhaustive]pub struct BatchGetItemOutputBuilder { /* private fields */ }
Expand description
A builder for BatchGetItemOutput
.
Implementations§
source§impl BatchGetItemOutputBuilder
impl BatchGetItemOutputBuilder
sourcepub fn responses(
self,
k: impl Into<String>,
v: Vec<HashMap<String, AttributeValue>>
) -> Self
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 to a list of items. Each object in Responses
consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
sourcepub fn set_responses(
self,
input: Option<HashMap<String, Vec<HashMap<String, AttributeValue>>>>
) -> Self
pub fn set_responses( self, input: Option<HashMap<String, Vec<HashMap<String, AttributeValue>>>> ) -> Self
A map of table name to a list of items. Each object in Responses
consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
sourcepub fn get_responses(
&self
) -> &Option<HashMap<String, Vec<HashMap<String, AttributeValue>>>>
pub fn get_responses( &self ) -> &Option<HashMap<String, Vec<HashMap<String, AttributeValue>>>>
A map of table name to a list of items. Each object in Responses
consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
sourcepub fn unprocessed_keys(
self,
k: impl Into<String>,
v: KeysAndAttributes
) -> Self
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 totrue
, 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.
sourcepub fn set_unprocessed_keys(
self,
input: Option<HashMap<String, KeysAndAttributes>>
) -> Self
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 totrue
, 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.
sourcepub fn get_unprocessed_keys(
&self
) -> &Option<HashMap<String, KeysAndAttributes>>
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 totrue
, 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.
sourcepub fn consumed_capacity(self, input: ConsumedCapacity) -> Self
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.
sourcepub fn set_consumed_capacity(self, input: Option<Vec<ConsumedCapacity>>) -> Self
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.
sourcepub fn get_consumed_capacity(&self) -> &Option<Vec<ConsumedCapacity>>
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.
sourcepub fn build(self) -> BatchGetItemOutput
pub fn build(self) -> BatchGetItemOutput
Consumes the builder and constructs a BatchGetItemOutput
.
Trait Implementations§
source§impl Clone for BatchGetItemOutputBuilder
impl Clone for BatchGetItemOutputBuilder
source§fn clone(&self) -> BatchGetItemOutputBuilder
fn clone(&self) -> BatchGetItemOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for BatchGetItemOutputBuilder
impl Debug for BatchGetItemOutputBuilder
source§impl Default for BatchGetItemOutputBuilder
impl Default for BatchGetItemOutputBuilder
source§fn default() -> BatchGetItemOutputBuilder
fn default() -> BatchGetItemOutputBuilder
source§impl PartialEq for BatchGetItemOutputBuilder
impl PartialEq for BatchGetItemOutputBuilder
source§fn eq(&self, other: &BatchGetItemOutputBuilder) -> bool
fn eq(&self, other: &BatchGetItemOutputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.