pub struct CreateChannelFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateChannel
.
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in the header.
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 app_instance_arn(self, input: impl Into<String>) -> Self
pub fn app_instance_arn(self, input: impl Into<String>) -> Self
The ARN of the channel request.
Sourcepub fn set_app_instance_arn(self, input: Option<String>) -> Self
pub fn set_app_instance_arn(self, input: Option<String>) -> Self
The ARN of the channel request.
Sourcepub fn get_app_instance_arn(&self) -> &Option<String>
pub fn get_app_instance_arn(&self) -> &Option<String>
The ARN of the channel request.
Sourcepub fn mode(self, input: ChannelMode) -> Self
pub fn mode(self, input: ChannelMode) -> Self
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
Sourcepub fn set_mode(self, input: Option<ChannelMode>) -> Self
pub fn set_mode(self, input: Option<ChannelMode>) -> Self
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
Sourcepub fn get_mode(&self) -> &Option<ChannelMode>
pub fn get_mode(&self) -> &Option<ChannelMode>
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
Sourcepub fn privacy(self, input: ChannelPrivacy) -> Self
pub fn privacy(self, input: ChannelPrivacy) -> Self
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
Sourcepub fn set_privacy(self, input: Option<ChannelPrivacy>) -> Self
pub fn set_privacy(self, input: Option<ChannelPrivacy>) -> Self
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
Sourcepub fn get_privacy(&self) -> &Option<ChannelPrivacy>
pub fn get_privacy(&self) -> &Option<ChannelPrivacy>
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
Sourcepub fn metadata(self, input: impl Into<String>) -> Self
pub fn metadata(self, input: impl Into<String>) -> Self
The metadata of the creation request. Limited to 1KB and UTF-8.
Sourcepub fn set_metadata(self, input: Option<String>) -> Self
pub fn set_metadata(self, input: Option<String>) -> Self
The metadata of the creation request. Limited to 1KB and UTF-8.
Sourcepub fn get_metadata(&self) -> &Option<String>
pub fn get_metadata(&self) -> &Option<String>
The metadata of the creation request. Limited to 1KB and UTF-8.
Sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
The client token for the request. An Idempotency
token.
Sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
The client token for the request. An Idempotency
token.
Sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
The client token for the request. An Idempotency
token.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
The tags for the creation request.
The tags for the creation request.
The tags for the creation request.
Sourcepub fn chime_bearer(self, input: impl Into<String>) -> Self
pub fn chime_bearer(self, input: impl Into<String>) -> Self
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
Sourcepub fn set_chime_bearer(self, input: Option<String>) -> Self
pub fn set_chime_bearer(self, input: Option<String>) -> Self
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
Sourcepub fn get_chime_bearer(&self) -> &Option<String>
pub fn get_chime_bearer(&self) -> &Option<String>
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
Sourcepub fn channel_id(self, input: impl Into<String>) -> Self
pub fn channel_id(self, input: impl Into<String>) -> Self
An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.
Sourcepub fn set_channel_id(self, input: Option<String>) -> Self
pub fn set_channel_id(self, input: Option<String>) -> Self
An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.
Sourcepub fn get_channel_id(&self) -> &Option<String>
pub fn get_channel_id(&self) -> &Option<String>
An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.
Sourcepub fn member_arns(self, input: impl Into<String>) -> Self
pub fn member_arns(self, input: impl Into<String>) -> Self
Appends an item to MemberArns
.
To override the contents of this collection use set_member_arns
.
The ARNs of the channel members in the request.
Sourcepub fn set_member_arns(self, input: Option<Vec<String>>) -> Self
pub fn set_member_arns(self, input: Option<Vec<String>>) -> Self
The ARNs of the channel members in the request.
Sourcepub fn get_member_arns(&self) -> &Option<Vec<String>>
pub fn get_member_arns(&self) -> &Option<Vec<String>>
The ARNs of the channel members in the request.
Sourcepub fn moderator_arns(self, input: impl Into<String>) -> Self
pub fn moderator_arns(self, input: impl Into<String>) -> Self
Appends an item to ModeratorArns
.
To override the contents of this collection use set_moderator_arns
.
The ARNs of the channel moderators in the request.
Sourcepub fn set_moderator_arns(self, input: Option<Vec<String>>) -> Self
pub fn set_moderator_arns(self, input: Option<Vec<String>>) -> Self
The ARNs of the channel moderators in the request.
Sourcepub fn get_moderator_arns(&self) -> &Option<Vec<String>>
pub fn get_moderator_arns(&self) -> &Option<Vec<String>>
The ARNs of the channel moderators in the request.
Sourcepub fn elastic_channel_configuration(
self,
input: ElasticChannelConfiguration,
) -> Self
pub fn elastic_channel_configuration( self, input: ElasticChannelConfiguration, ) -> Self
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
Sourcepub fn set_elastic_channel_configuration(
self,
input: Option<ElasticChannelConfiguration>,
) -> Self
pub fn set_elastic_channel_configuration( self, input: Option<ElasticChannelConfiguration>, ) -> Self
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
Sourcepub fn get_elastic_channel_configuration(
&self,
) -> &Option<ElasticChannelConfiguration>
pub fn get_elastic_channel_configuration( &self, ) -> &Option<ElasticChannelConfiguration>
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
Sourcepub fn expiration_settings(self, input: ExpirationSettings) -> Self
pub fn expiration_settings(self, input: ExpirationSettings) -> Self
Settings that control the interval after which the channel is automatically deleted.
Sourcepub fn set_expiration_settings(self, input: Option<ExpirationSettings>) -> Self
pub fn set_expiration_settings(self, input: Option<ExpirationSettings>) -> Self
Settings that control the interval after which the channel is automatically deleted.
Sourcepub fn get_expiration_settings(&self) -> &Option<ExpirationSettings>
pub fn get_expiration_settings(&self) -> &Option<ExpirationSettings>
Settings that control the interval after which the channel is automatically deleted.
Trait Implementations§
Source§impl Clone for CreateChannelFluentBuilder
impl Clone for CreateChannelFluentBuilder
Source§fn clone(&self) -> CreateChannelFluentBuilder
fn clone(&self) -> CreateChannelFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
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);