Struct aws_sdk_dynamodb::operation::put_item::builders::PutItemOutputBuilder
source · #[non_exhaustive]pub struct PutItemOutputBuilder { /* private fields */ }
Expand description
A builder for PutItemOutput
.
Implementations§
source§impl PutItemOutputBuilder
impl PutItemOutputBuilder
sourcepub fn attributes(self, k: impl Into<String>, v: AttributeValue) -> Self
pub fn attributes(self, k: impl Into<String>, v: AttributeValue) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
The attribute values as they appeared before the PutItem
operation, but only if ReturnValues
is specified as ALL_OLD
in the request. Each element consists of an attribute name and an attribute value.
sourcepub fn set_attributes(
self,
input: Option<HashMap<String, AttributeValue>>,
) -> Self
pub fn set_attributes( self, input: Option<HashMap<String, AttributeValue>>, ) -> Self
The attribute values as they appeared before the PutItem
operation, but only if ReturnValues
is specified as ALL_OLD
in the request. Each element consists of an attribute name and an attribute value.
sourcepub fn get_attributes(&self) -> &Option<HashMap<String, AttributeValue>>
pub fn get_attributes(&self) -> &Option<HashMap<String, AttributeValue>>
The attribute values as they appeared before the PutItem
operation, but only if ReturnValues
is specified as ALL_OLD
in the request. Each element consists of an attribute name and an attribute value.
sourcepub fn consumed_capacity(self, input: ConsumedCapacity) -> Self
pub fn consumed_capacity(self, input: ConsumedCapacity) -> Self
The capacity units consumed by the PutItem
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 unity consumption for write operations in the Amazon DynamoDB Developer Guide.
sourcepub fn set_consumed_capacity(self, input: Option<ConsumedCapacity>) -> Self
pub fn set_consumed_capacity(self, input: Option<ConsumedCapacity>) -> Self
The capacity units consumed by the PutItem
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 unity consumption for write operations in the Amazon DynamoDB Developer Guide.
sourcepub fn get_consumed_capacity(&self) -> &Option<ConsumedCapacity>
pub fn get_consumed_capacity(&self) -> &Option<ConsumedCapacity>
The capacity units consumed by the PutItem
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 unity consumption for write operations in the Amazon DynamoDB Developer Guide.
sourcepub fn item_collection_metrics(self, input: ItemCollectionMetrics) -> Self
pub fn item_collection_metrics(self, input: ItemCollectionMetrics) -> Self
Information about item collections, if any, that were affected by the PutItem
operation. ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics
element consists of:
-
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item itself. -
SizeEstimateRangeGB
- An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
sourcepub fn set_item_collection_metrics(
self,
input: Option<ItemCollectionMetrics>,
) -> Self
pub fn set_item_collection_metrics( self, input: Option<ItemCollectionMetrics>, ) -> Self
Information about item collections, if any, that were affected by the PutItem
operation. ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics
element consists of:
-
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item itself. -
SizeEstimateRangeGB
- An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
sourcepub fn get_item_collection_metrics(&self) -> &Option<ItemCollectionMetrics>
pub fn get_item_collection_metrics(&self) -> &Option<ItemCollectionMetrics>
Information about item collections, if any, that were affected by the PutItem
operation. ItemCollectionMetrics
is only returned if the ReturnItemCollectionMetrics
parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics
element consists of:
-
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item itself. -
SizeEstimateRangeGB
- An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
sourcepub fn build(self) -> PutItemOutput
pub fn build(self) -> PutItemOutput
Consumes the builder and constructs a PutItemOutput
.
Trait Implementations§
source§impl Clone for PutItemOutputBuilder
impl Clone for PutItemOutputBuilder
source§fn clone(&self) -> PutItemOutputBuilder
fn clone(&self) -> PutItemOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PutItemOutputBuilder
impl Debug for PutItemOutputBuilder
source§impl Default for PutItemOutputBuilder
impl Default for PutItemOutputBuilder
source§fn default() -> PutItemOutputBuilder
fn default() -> PutItemOutputBuilder
source§impl PartialEq for PutItemOutputBuilder
impl PartialEq for PutItemOutputBuilder
source§fn eq(&self, other: &PutItemOutputBuilder) -> bool
fn eq(&self, other: &PutItemOutputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for PutItemOutputBuilder
Auto Trait Implementations§
impl Freeze for PutItemOutputBuilder
impl RefUnwindSafe for PutItemOutputBuilder
impl Send for PutItemOutputBuilder
impl Sync for PutItemOutputBuilder
impl Unpin for PutItemOutputBuilder
impl UnwindSafe for PutItemOutputBuilder
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);