#[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 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.
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 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.
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 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.
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 ==
.impl StructuralPartialEq for BatchGetItemOutputBuilder
Auto Trait Implementations§
impl Freeze for BatchGetItemOutputBuilder
impl RefUnwindSafe for BatchGetItemOutputBuilder
impl Send for BatchGetItemOutputBuilder
impl Sync for BatchGetItemOutputBuilder
impl Unpin for BatchGetItemOutputBuilder
impl UnwindSafe for BatchGetItemOutputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);