#[non_exhaustive]pub struct DescribePipeOutput {Show 18 fields
pub arn: Option<String>,
pub name: Option<String>,
pub description: Option<String>,
pub desired_state: Option<RequestedPipeStateDescribeResponse>,
pub current_state: Option<PipeState>,
pub state_reason: Option<String>,
pub source: Option<String>,
pub source_parameters: Option<PipeSourceParameters>,
pub enrichment: Option<String>,
pub enrichment_parameters: Option<PipeEnrichmentParameters>,
pub target: Option<String>,
pub target_parameters: Option<PipeTargetParameters>,
pub role_arn: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub creation_time: Option<DateTime>,
pub last_modified_time: Option<DateTime>,
pub log_configuration: Option<PipeLogConfiguration>,
pub kms_key_identifier: Option<String>,
/* private fields */
}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.arn: Option<String>The ARN of the pipe.
name: Option<String>The name of the pipe.
description: Option<String>A description of the pipe.
desired_state: Option<RequestedPipeStateDescribeResponse>The state the pipe should be in.
current_state: Option<PipeState>The state the pipe is in.
state_reason: Option<String>The reason the pipe is in its current state.
source: Option<String>The ARN of the source resource.
source_parameters: Option<PipeSourceParameters>The parameters required to set up a source for your pipe.
enrichment: Option<String>The ARN of the enrichment resource.
enrichment_parameters: Option<PipeEnrichmentParameters>The parameters required to set up enrichment on your pipe.
target: Option<String>The ARN of the target resource.
target_parameters: Option<PipeTargetParameters>The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
role_arn: Option<String>The ARN of the role that allows the pipe to send data to the target.
The list of key-value pairs to associate with the pipe.
creation_time: Option<DateTime>The time the pipe was created.
last_modified_time: Option<DateTime>When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
log_configuration: Option<PipeLogConfiguration>The logging configuration settings for the pipe.
kms_key_identifier: Option<String>The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.
For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
Implementations§
Source§impl DescribePipeOutput
impl DescribePipeOutput
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the pipe.
Sourcepub fn desired_state(&self) -> Option<&RequestedPipeStateDescribeResponse>
pub fn desired_state(&self) -> Option<&RequestedPipeStateDescribeResponse>
The state the pipe should be in.
Sourcepub fn current_state(&self) -> Option<&PipeState>
pub fn current_state(&self) -> Option<&PipeState>
The state the pipe is in.
Sourcepub fn state_reason(&self) -> Option<&str>
pub fn state_reason(&self) -> Option<&str>
The reason the pipe is in its current state.
Sourcepub fn source_parameters(&self) -> Option<&PipeSourceParameters>
pub fn source_parameters(&self) -> Option<&PipeSourceParameters>
The parameters required to set up a source for your pipe.
Sourcepub fn enrichment(&self) -> Option<&str>
pub fn enrichment(&self) -> Option<&str>
The ARN of the enrichment resource.
Sourcepub fn enrichment_parameters(&self) -> Option<&PipeEnrichmentParameters>
pub fn enrichment_parameters(&self) -> Option<&PipeEnrichmentParameters>
The parameters required to set up enrichment on your pipe.
Sourcepub fn target_parameters(&self) -> Option<&PipeTargetParameters>
pub fn target_parameters(&self) -> Option<&PipeTargetParameters>
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The ARN of the role that allows the pipe to send data to the target.
The list of key-value pairs to associate with the pipe.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
The time the pipe was created.
Sourcepub fn last_modified_time(&self) -> Option<&DateTime>
pub fn last_modified_time(&self) -> Option<&DateTime>
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Sourcepub fn log_configuration(&self) -> Option<&PipeLogConfiguration>
pub fn log_configuration(&self) -> Option<&PipeLogConfiguration>
The logging configuration settings for the pipe.
Sourcepub fn kms_key_identifier(&self) -> Option<&str>
pub fn kms_key_identifier(&self) -> Option<&str>
The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.
For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
Source§impl DescribePipeOutput
impl DescribePipeOutput
Sourcepub fn builder() -> DescribePipeOutputBuilder
pub fn builder() -> DescribePipeOutputBuilder
Creates a new builder-style object to manufacture DescribePipeOutput.
Trait Implementations§
Source§impl Clone for DescribePipeOutput
impl Clone for DescribePipeOutput
Source§fn clone(&self) -> DescribePipeOutput
fn clone(&self) -> DescribePipeOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DescribePipeOutput
impl Debug for DescribePipeOutput
Source§impl PartialEq for DescribePipeOutput
impl PartialEq for DescribePipeOutput
Source§impl RequestId for DescribePipeOutput
impl RequestId for DescribePipeOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for DescribePipeOutput
Auto Trait Implementations§
impl Freeze for DescribePipeOutput
impl RefUnwindSafe for DescribePipeOutput
impl Send for DescribePipeOutput
impl Sync for DescribePipeOutput
impl Unpin for DescribePipeOutput
impl UnwindSafe for DescribePipeOutput
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);