#[non_exhaustive]pub struct StreamDescriptionSummaryBuilder { /* private fields */ }Expand description
A builder for StreamDescriptionSummary.
Implementations§
Source§impl StreamDescriptionSummaryBuilder
impl StreamDescriptionSummaryBuilder
Sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The name of the stream being described.
This field is required.Sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the stream being described.
Sourcepub fn get_stream_name(&self) -> &Option<String>
pub fn get_stream_name(&self) -> &Option<String>
The name of the stream being described.
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 being described.
This field is required.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 being described.
Sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the stream being described.
Sourcepub fn stream_status(self, input: StreamStatus) -> Self
pub fn stream_status(self, input: StreamStatus) -> Self
The current status of the stream being described. The stream status is one of the following states:
-
CREATING- The stream is being created. Kinesis Data Streams immediately returns and setsStreamStatustoCREATING. -
DELETING- The stream is being deleted. The specified stream is in theDELETINGstate until Kinesis Data Streams completes the deletion. -
ACTIVE- The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on anACTIVEstream. -
UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
Sourcepub fn set_stream_status(self, input: Option<StreamStatus>) -> Self
pub fn set_stream_status(self, input: Option<StreamStatus>) -> Self
The current status of the stream being described. The stream status is one of the following states:
-
CREATING- The stream is being created. Kinesis Data Streams immediately returns and setsStreamStatustoCREATING. -
DELETING- The stream is being deleted. The specified stream is in theDELETINGstate until Kinesis Data Streams completes the deletion. -
ACTIVE- The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on anACTIVEstream. -
UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
Sourcepub fn get_stream_status(&self) -> &Option<StreamStatus>
pub fn get_stream_status(&self) -> &Option<StreamStatus>
The current status of the stream being described. The stream status is one of the following states:
-
CREATING- The stream is being created. Kinesis Data Streams immediately returns and setsStreamStatustoCREATING. -
DELETING- The stream is being deleted. The specified stream is in theDELETINGstate until Kinesis Data Streams completes the deletion. -
ACTIVE- The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on anACTIVEstream. -
UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
Sourcepub fn stream_mode_details(self, input: StreamModeDetails) -> Self
pub fn stream_mode_details(self, input: StreamModeDetails) -> Self
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
Sourcepub fn set_stream_mode_details(self, input: Option<StreamModeDetails>) -> Self
pub fn set_stream_mode_details(self, input: Option<StreamModeDetails>) -> Self
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
Sourcepub fn get_stream_mode_details(&self) -> &Option<StreamModeDetails>
pub fn get_stream_mode_details(&self) -> &Option<StreamModeDetails>
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
Sourcepub fn retention_period_hours(self, input: i32) -> Self
pub fn retention_period_hours(self, input: i32) -> Self
The current retention period, in hours.
This field is required.Sourcepub fn set_retention_period_hours(self, input: Option<i32>) -> Self
pub fn set_retention_period_hours(self, input: Option<i32>) -> Self
The current retention period, in hours.
Sourcepub fn get_retention_period_hours(&self) -> &Option<i32>
pub fn get_retention_period_hours(&self) -> &Option<i32>
The current retention period, in hours.
Sourcepub fn stream_creation_timestamp(self, input: DateTime) -> Self
pub fn stream_creation_timestamp(self, input: DateTime) -> Self
The approximate time that the stream was created.
This field is required.Sourcepub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
The approximate time that the stream was created.
Sourcepub fn get_stream_creation_timestamp(&self) -> &Option<DateTime>
pub fn get_stream_creation_timestamp(&self) -> &Option<DateTime>
The approximate time that the stream was created.
Sourcepub fn enhanced_monitoring(self, input: EnhancedMetrics) -> Self
pub fn enhanced_monitoring(self, input: EnhancedMetrics) -> Self
Appends an item to enhanced_monitoring.
To override the contents of this collection use set_enhanced_monitoring.
Represents the current enhanced monitoring settings of the stream.
Sourcepub fn set_enhanced_monitoring(
self,
input: Option<Vec<EnhancedMetrics>>,
) -> Self
pub fn set_enhanced_monitoring( self, input: Option<Vec<EnhancedMetrics>>, ) -> Self
Represents the current enhanced monitoring settings of the stream.
Sourcepub fn get_enhanced_monitoring(&self) -> &Option<Vec<EnhancedMetrics>>
pub fn get_enhanced_monitoring(&self) -> &Option<Vec<EnhancedMetrics>>
Represents the current enhanced monitoring settings of the stream.
Sourcepub fn encryption_type(self, input: EncryptionType) -> Self
pub fn encryption_type(self, input: EncryptionType) -> Self
The encryption type used. This value is one of the following:
-
KMS -
NONE
Sourcepub fn set_encryption_type(self, input: Option<EncryptionType>) -> Self
pub fn set_encryption_type(self, input: Option<EncryptionType>) -> Self
The encryption type used. This value is one of the following:
-
KMS -
NONE
Sourcepub fn get_encryption_type(&self) -> &Option<EncryptionType>
pub fn get_encryption_type(&self) -> &Option<EncryptionType>
The encryption type used. This value is one of the following:
-
KMS -
NONE
Sourcepub fn key_id(self, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
-
Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 -
Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName -
Globally unique key ID example:
12345678-1234-1234-1234-123456789012 -
Alias name example:
alias/MyAliasName -
Master key owned by Kinesis Data Streams:
alias/aws/kinesis
Sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
-
Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 -
Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName -
Globally unique key ID example:
12345678-1234-1234-1234-123456789012 -
Alias name example:
alias/MyAliasName -
Master key owned by Kinesis Data Streams:
alias/aws/kinesis
Sourcepub fn get_key_id(&self) -> &Option<String>
pub fn get_key_id(&self) -> &Option<String>
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
-
Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 -
Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName -
Globally unique key ID example:
12345678-1234-1234-1234-123456789012 -
Alias name example:
alias/MyAliasName -
Master key owned by Kinesis Data Streams:
alias/aws/kinesis
Sourcepub fn open_shard_count(self, input: i32) -> Self
pub fn open_shard_count(self, input: i32) -> Self
The number of open shards in the stream.
This field is required.Sourcepub fn set_open_shard_count(self, input: Option<i32>) -> Self
pub fn set_open_shard_count(self, input: Option<i32>) -> Self
The number of open shards in the stream.
Sourcepub fn get_open_shard_count(&self) -> &Option<i32>
pub fn get_open_shard_count(&self) -> &Option<i32>
The number of open shards in the stream.
Sourcepub fn consumer_count(self, input: i32) -> Self
pub fn consumer_count(self, input: i32) -> Self
The number of enhanced fan-out consumers registered with the stream.
Sourcepub fn set_consumer_count(self, input: Option<i32>) -> Self
pub fn set_consumer_count(self, input: Option<i32>) -> Self
The number of enhanced fan-out consumers registered with the stream.
Sourcepub fn get_consumer_count(&self) -> &Option<i32>
pub fn get_consumer_count(&self) -> &Option<i32>
The number of enhanced fan-out consumers registered with the stream.
Sourcepub fn warm_throughput(self, input: WarmThroughputObject) -> Self
pub fn warm_throughput(self, input: WarmThroughputObject) -> Self
The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.
Sourcepub fn set_warm_throughput(self, input: Option<WarmThroughputObject>) -> Self
pub fn set_warm_throughput(self, input: Option<WarmThroughputObject>) -> Self
The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.
Sourcepub fn get_warm_throughput(&self) -> &Option<WarmThroughputObject>
pub fn get_warm_throughput(&self) -> &Option<WarmThroughputObject>
The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.
Sourcepub fn max_record_size_in_kib(self, input: i32) -> Self
pub fn max_record_size_in_kib(self, input: i32) -> Self
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
Sourcepub fn set_max_record_size_in_kib(self, input: Option<i32>) -> Self
pub fn set_max_record_size_in_kib(self, input: Option<i32>) -> Self
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
Sourcepub fn get_max_record_size_in_kib(&self) -> &Option<i32>
pub fn get_max_record_size_in_kib(&self) -> &Option<i32>
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
Sourcepub fn build(self) -> Result<StreamDescriptionSummary, BuildError>
pub fn build(self) -> Result<StreamDescriptionSummary, BuildError>
Consumes the builder and constructs a StreamDescriptionSummary.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for StreamDescriptionSummaryBuilder
impl Clone for StreamDescriptionSummaryBuilder
Source§fn clone(&self) -> StreamDescriptionSummaryBuilder
fn clone(&self) -> StreamDescriptionSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for StreamDescriptionSummaryBuilder
impl Default for StreamDescriptionSummaryBuilder
Source§fn default() -> StreamDescriptionSummaryBuilder
fn default() -> StreamDescriptionSummaryBuilder
Source§impl PartialEq for StreamDescriptionSummaryBuilder
impl PartialEq for StreamDescriptionSummaryBuilder
Source§fn eq(&self, other: &StreamDescriptionSummaryBuilder) -> bool
fn eq(&self, other: &StreamDescriptionSummaryBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for StreamDescriptionSummaryBuilder
Auto Trait Implementations§
impl Freeze for StreamDescriptionSummaryBuilder
impl RefUnwindSafe for StreamDescriptionSummaryBuilder
impl Send for StreamDescriptionSummaryBuilder
impl Sync for StreamDescriptionSummaryBuilder
impl Unpin for StreamDescriptionSummaryBuilder
impl UnwindSafe for StreamDescriptionSummaryBuilder
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);