pub struct CreateChannelFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateChannel
.
Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
Implementations§
Source§impl CreateChannelFluentBuilder
impl CreateChannelFluentBuilder
Sourcepub fn as_input(&self) -> &CreateChannelInputBuilder
pub fn as_input(&self) -> &CreateChannelInputBuilder
Access the CreateChannel as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateChannelOutput, SdkError<CreateChannelError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateChannelOutput, SdkError<CreateChannelError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateChannelOutput, CreateChannelError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateChannelOutput, CreateChannelError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn channel_name(self, input: impl Into<String>) -> Self
pub fn channel_name(self, input: impl Into<String>) -> Self
The name of the channel.
Sourcepub fn set_channel_name(self, input: Option<String>) -> Self
pub fn set_channel_name(self, input: Option<String>) -> Self
The name of the channel.
Sourcepub fn get_channel_name(&self) -> &Option<String>
pub fn get_channel_name(&self) -> &Option<String>
The name of the channel.
Sourcepub fn channel_storage(self, input: ChannelStorage) -> Self
pub fn channel_storage(self, input: ChannelStorage) -> Self
Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3
storage. If not specified, the default is serviceManagedS3
. You can't change this storage option after the channel is created.
Sourcepub fn set_channel_storage(self, input: Option<ChannelStorage>) -> Self
pub fn set_channel_storage(self, input: Option<ChannelStorage>) -> Self
Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3
storage. If not specified, the default is serviceManagedS3
. You can't change this storage option after the channel is created.
Sourcepub fn get_channel_storage(&self) -> &Option<ChannelStorage>
pub fn get_channel_storage(&self) -> &Option<ChannelStorage>
Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3
storage. If not specified, the default is serviceManagedS3
. You can't change this storage option after the channel is created.
Sourcepub fn retention_period(self, input: RetentionPeriod) -> Self
pub fn retention_period(self, input: RetentionPeriod) -> Self
How long, in days, message data is kept for the channel. When customerManagedS3
storage is selected, this parameter is ignored.
Sourcepub fn set_retention_period(self, input: Option<RetentionPeriod>) -> Self
pub fn set_retention_period(self, input: Option<RetentionPeriod>) -> Self
How long, in days, message data is kept for the channel. When customerManagedS3
storage is selected, this parameter is ignored.
Sourcepub fn get_retention_period(&self) -> &Option<RetentionPeriod>
pub fn get_retention_period(&self) -> &Option<RetentionPeriod>
How long, in days, message data is kept for the channel. When customerManagedS3
storage is selected, this parameter is ignored.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Metadata which can be used to manage the channel.
Metadata which can be used to manage the channel.
Metadata which can be used to manage the channel.
Trait Implementations§
Source§impl Clone for CreateChannelFluentBuilder
impl Clone for CreateChannelFluentBuilder
Source§fn clone(&self) -> CreateChannelFluentBuilder
fn clone(&self) -> CreateChannelFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateChannelFluentBuilder
impl !RefUnwindSafe for CreateChannelFluentBuilder
impl Send for CreateChannelFluentBuilder
impl Sync for CreateChannelFluentBuilder
impl Unpin for CreateChannelFluentBuilder
impl !UnwindSafe for CreateChannelFluentBuilder
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);