#[non_exhaustive]pub struct JournalKinesisStreamDescription {
pub ledger_name: String,
pub creation_time: Option<DateTime>,
pub inclusive_start_time: Option<DateTime>,
pub exclusive_end_time: Option<DateTime>,
pub role_arn: String,
pub stream_id: String,
pub arn: Option<String>,
pub status: StreamStatus,
pub kinesis_configuration: Option<KinesisConfiguration>,
pub error_cause: Option<ErrorCause>,
pub stream_name: String,
}
Expand description
Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.ledger_name: String
The name of the ledger.
creation_time: Option<DateTime>
The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
inclusive_start_time: Option<DateTime>
The inclusive start date and time from which to start streaming journal data.
exclusive_end_time: Option<DateTime>
The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
role_arn: String
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
stream_id: String
The UUID (represented in Base62-encoded text) of the QLDB journal stream.
arn: Option<String>
The Amazon Resource Name (ARN) of the QLDB journal stream.
status: StreamStatus
The current state of the QLDB journal stream.
kinesis_configuration: Option<KinesisConfiguration>
The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
error_cause: Option<ErrorCause>
The error message that describes the reason that a stream has a status of IMPAIRED
or FAILED
. This is not applicable to streams that have other status values.
stream_name: String
The user-defined name of the QLDB journal stream.
Implementations§
Source§impl JournalKinesisStreamDescription
impl JournalKinesisStreamDescription
Sourcepub fn ledger_name(&self) -> &str
pub fn ledger_name(&self) -> &str
The name of the ledger.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
Sourcepub fn inclusive_start_time(&self) -> Option<&DateTime>
pub fn inclusive_start_time(&self) -> Option<&DateTime>
The inclusive start date and time from which to start streaming journal data.
Sourcepub fn exclusive_end_time(&self) -> Option<&DateTime>
pub fn exclusive_end_time(&self) -> Option<&DateTime>
The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
Sourcepub fn role_arn(&self) -> &str
pub fn role_arn(&self) -> &str
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
Sourcepub fn stream_id(&self) -> &str
pub fn stream_id(&self) -> &str
The UUID (represented in Base62-encoded text) of the QLDB journal stream.
Sourcepub fn status(&self) -> &StreamStatus
pub fn status(&self) -> &StreamStatus
The current state of the QLDB journal stream.
Sourcepub fn kinesis_configuration(&self) -> Option<&KinesisConfiguration>
pub fn kinesis_configuration(&self) -> Option<&KinesisConfiguration>
The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
Sourcepub fn error_cause(&self) -> Option<&ErrorCause>
pub fn error_cause(&self) -> Option<&ErrorCause>
The error message that describes the reason that a stream has a status of IMPAIRED
or FAILED
. This is not applicable to streams that have other status values.
Sourcepub fn stream_name(&self) -> &str
pub fn stream_name(&self) -> &str
The user-defined name of the QLDB journal stream.
Source§impl JournalKinesisStreamDescription
impl JournalKinesisStreamDescription
Sourcepub fn builder() -> JournalKinesisStreamDescriptionBuilder
pub fn builder() -> JournalKinesisStreamDescriptionBuilder
Creates a new builder-style object to manufacture JournalKinesisStreamDescription
.
Trait Implementations§
Source§impl Clone for JournalKinesisStreamDescription
impl Clone for JournalKinesisStreamDescription
Source§fn clone(&self) -> JournalKinesisStreamDescription
fn clone(&self) -> JournalKinesisStreamDescription
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for JournalKinesisStreamDescription
impl PartialEq for JournalKinesisStreamDescription
Source§fn eq(&self, other: &JournalKinesisStreamDescription) -> bool
fn eq(&self, other: &JournalKinesisStreamDescription) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for JournalKinesisStreamDescription
Auto Trait Implementations§
impl Freeze for JournalKinesisStreamDescription
impl RefUnwindSafe for JournalKinesisStreamDescription
impl Send for JournalKinesisStreamDescription
impl Sync for JournalKinesisStreamDescription
impl Unpin for JournalKinesisStreamDescription
impl UnwindSafe for JournalKinesisStreamDescription
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);