#[non_exhaustive]pub struct StreamDescriptionBuilder { /* private fields */ }
Expand description
A builder for StreamDescription
.
Implementations§
Source§impl StreamDescriptionBuilder
impl StreamDescriptionBuilder
Sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
Sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
Sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the stream.
Sourcepub fn stream_label(self, input: impl Into<String>) -> Self
pub fn stream_label(self, input: impl Into<String>) -> Self
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
-
the Amazon Web Services customer ID.
-
the table name
-
the
StreamLabel
Sourcepub fn set_stream_label(self, input: Option<String>) -> Self
pub fn set_stream_label(self, input: Option<String>) -> Self
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
-
the Amazon Web Services customer ID.
-
the table name
-
the
StreamLabel
Sourcepub fn get_stream_label(&self) -> &Option<String>
pub fn get_stream_label(&self) -> &Option<String>
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel
is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
-
the Amazon Web Services customer ID.
-
the table name
-
the
StreamLabel
Sourcepub fn stream_status(self, input: StreamStatus) -> Self
pub fn stream_status(self, input: StreamStatus) -> Self
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLED
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
Sourcepub fn set_stream_status(self, input: Option<StreamStatus>) -> Self
pub fn set_stream_status(self, input: Option<StreamStatus>) -> Self
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLED
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
Sourcepub fn get_stream_status(&self) -> &Option<StreamStatus>
pub fn get_stream_status(&self) -> &Option<StreamStatus>
Indicates the current status of the stream:
-
ENABLING
- Streams is currently being enabled on the DynamoDB table. -
ENABLED
- the stream is enabled. -
DISABLING
- Streams is currently being disabled on the DynamoDB table. -
DISABLED
- the stream is disabled.
Sourcepub fn stream_view_type(self, input: StreamViewType) -> Self
pub fn stream_view_type(self, input: StreamViewType) -> Self
Indicates the format of the records within this stream:
-
KEYS_ONLY
- only the key attributes of items that were modified in the DynamoDB table. -
NEW_IMAGE
- entire items from the table, as they appeared after they were modified. -
OLD_IMAGE
- entire items from the table, as they appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
Sourcepub fn set_stream_view_type(self, input: Option<StreamViewType>) -> Self
pub fn set_stream_view_type(self, input: Option<StreamViewType>) -> Self
Indicates the format of the records within this stream:
-
KEYS_ONLY
- only the key attributes of items that were modified in the DynamoDB table. -
NEW_IMAGE
- entire items from the table, as they appeared after they were modified. -
OLD_IMAGE
- entire items from the table, as they appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
Sourcepub fn get_stream_view_type(&self) -> &Option<StreamViewType>
pub fn get_stream_view_type(&self) -> &Option<StreamViewType>
Indicates the format of the records within this stream:
-
KEYS_ONLY
- only the key attributes of items that were modified in the DynamoDB table. -
NEW_IMAGE
- entire items from the table, as they appeared after they were modified. -
OLD_IMAGE
- entire items from the table, as they appeared before they were modified. -
NEW_AND_OLD_IMAGES
- both the new and the old images of the items from the table.
Sourcepub fn creation_request_date_time(self, input: DateTime) -> Self
pub fn creation_request_date_time(self, input: DateTime) -> Self
The date and time when the request to create this stream was issued.
Sourcepub fn set_creation_request_date_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_request_date_time(self, input: Option<DateTime>) -> Self
The date and time when the request to create this stream was issued.
Sourcepub fn get_creation_request_date_time(&self) -> &Option<DateTime>
pub fn get_creation_request_date_time(&self) -> &Option<DateTime>
The date and time when the request to create this stream was issued.
Sourcepub fn table_name(self, input: impl Into<String>) -> Self
pub fn table_name(self, input: impl Into<String>) -> Self
The DynamoDB table with which the stream is associated.
Sourcepub fn set_table_name(self, input: Option<String>) -> Self
pub fn set_table_name(self, input: Option<String>) -> Self
The DynamoDB table with which the stream is associated.
Sourcepub fn get_table_name(&self) -> &Option<String>
pub fn get_table_name(&self) -> &Option<String>
The DynamoDB table with which the stream is associated.
Sourcepub fn key_schema(self, input: KeySchemaElement) -> Self
pub fn key_schema(self, input: KeySchemaElement) -> Self
Appends an item to key_schema
.
To override the contents of this collection use set_key_schema
.
The key attribute(s) of the stream's DynamoDB table.
Sourcepub fn set_key_schema(self, input: Option<Vec<KeySchemaElement>>) -> Self
pub fn set_key_schema(self, input: Option<Vec<KeySchemaElement>>) -> Self
The key attribute(s) of the stream's DynamoDB table.
Sourcepub fn get_key_schema(&self) -> &Option<Vec<KeySchemaElement>>
pub fn get_key_schema(&self) -> &Option<Vec<KeySchemaElement>>
The key attribute(s) of the stream's DynamoDB table.
Sourcepub fn shards(self, input: Shard) -> Self
pub fn shards(self, input: Shard) -> Self
Appends an item to shards
.
To override the contents of this collection use set_shards
.
The shards that comprise the stream.
Sourcepub fn set_shards(self, input: Option<Vec<Shard>>) -> Self
pub fn set_shards(self, input: Option<Vec<Shard>>) -> Self
The shards that comprise the stream.
Sourcepub fn get_shards(&self) -> &Option<Vec<Shard>>
pub fn get_shards(&self) -> &Option<Vec<Shard>>
The shards that comprise the stream.
Sourcepub fn last_evaluated_shard_id(self, input: impl Into<String>) -> Self
pub fn last_evaluated_shard_id(self, input: impl Into<String>) -> Self
The shard ID 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 LastEvaluatedShardId
is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.
If LastEvaluatedShardId
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 LastEvaluatedShardId
is empty.
Sourcepub fn set_last_evaluated_shard_id(self, input: Option<String>) -> Self
pub fn set_last_evaluated_shard_id(self, input: Option<String>) -> Self
The shard ID 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 LastEvaluatedShardId
is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.
If LastEvaluatedShardId
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 LastEvaluatedShardId
is empty.
Sourcepub fn get_last_evaluated_shard_id(&self) -> &Option<String>
pub fn get_last_evaluated_shard_id(&self) -> &Option<String>
The shard ID 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 LastEvaluatedShardId
is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.
If LastEvaluatedShardId
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 LastEvaluatedShardId
is empty.
Sourcepub fn build(self) -> StreamDescription
pub fn build(self) -> StreamDescription
Consumes the builder and constructs a StreamDescription
.
Trait Implementations§
Source§impl Clone for StreamDescriptionBuilder
impl Clone for StreamDescriptionBuilder
Source§fn clone(&self) -> StreamDescriptionBuilder
fn clone(&self) -> StreamDescriptionBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StreamDescriptionBuilder
impl Debug for StreamDescriptionBuilder
Source§impl Default for StreamDescriptionBuilder
impl Default for StreamDescriptionBuilder
Source§fn default() -> StreamDescriptionBuilder
fn default() -> StreamDescriptionBuilder
Source§impl PartialEq for StreamDescriptionBuilder
impl PartialEq for StreamDescriptionBuilder
Source§fn eq(&self, other: &StreamDescriptionBuilder) -> bool
fn eq(&self, other: &StreamDescriptionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StreamDescriptionBuilder
Auto Trait Implementations§
impl Freeze for StreamDescriptionBuilder
impl RefUnwindSafe for StreamDescriptionBuilder
impl Send for StreamDescriptionBuilder
impl Sync for StreamDescriptionBuilder
impl Unpin for StreamDescriptionBuilder
impl UnwindSafe for StreamDescriptionBuilder
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§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§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();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§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();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§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();
Source§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.Source§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);