#[non_exhaustive]pub struct CreatePoolOutput {Show 13 fields
pub pool_arn: Option<String>,
pub pool_id: Option<String>,
pub status: Option<PoolStatus>,
pub message_type: Option<MessageType>,
pub two_way_enabled: bool,
pub two_way_channel_arn: Option<String>,
pub two_way_channel_role: Option<String>,
pub self_managed_opt_outs_enabled: bool,
pub opt_out_list_name: Option<String>,
pub shared_routes_enabled: bool,
pub deletion_protection_enabled: bool,
pub tags: Option<Vec<Tag>>,
pub created_timestamp: Option<DateTime>,
/* 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.pool_arn: Option<String>
The Amazon Resource Name (ARN) for the pool.
pool_id: Option<String>
The unique identifier for the pool.
status: Option<PoolStatus>
The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
message_type: Option<MessageType>
The type of message for the pool to use.
two_way_enabled: bool
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
two_way_channel_arn: Option<String>
The Amazon Resource Name (ARN) of the two way channel.
two_way_channel_role: Option<String>
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
self_managed_opt_outs_enabled: bool
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
opt_out_list_name: Option<String>
The name of the OptOutList associated with the pool.
Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
deletion_protection_enabled: bool
When set to true deletion protection is enabled. By default this is set to false.
An array of tags (key and value pairs) associated with the pool.
created_timestamp: Option<DateTime>
The time when the pool was created, in UNIX epoch time format.
Implementations§
Source§impl CreatePoolOutput
impl CreatePoolOutput
Sourcepub fn status(&self) -> Option<&PoolStatus>
pub fn status(&self) -> Option<&PoolStatus>
The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
Sourcepub fn message_type(&self) -> Option<&MessageType>
pub fn message_type(&self) -> Option<&MessageType>
The type of message for the pool to use.
Sourcepub fn two_way_enabled(&self) -> bool
pub fn two_way_enabled(&self) -> bool
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Sourcepub fn two_way_channel_arn(&self) -> Option<&str>
pub fn two_way_channel_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the two way channel.
Sourcepub fn two_way_channel_role(&self) -> Option<&str>
pub fn two_way_channel_role(&self) -> Option<&str>
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Sourcepub fn self_managed_opt_outs_enabled(&self) -> bool
pub fn self_managed_opt_outs_enabled(&self) -> bool
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
Sourcepub fn opt_out_list_name(&self) -> Option<&str>
pub fn opt_out_list_name(&self) -> Option<&str>
The name of the OptOutList associated with the pool.
Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
Sourcepub fn deletion_protection_enabled(&self) -> bool
pub fn deletion_protection_enabled(&self) -> bool
When set to true deletion protection is enabled. By default this is set to false.
An array of tags (key and value pairs) associated with the pool.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn created_timestamp(&self) -> Option<&DateTime>
pub fn created_timestamp(&self) -> Option<&DateTime>
The time when the pool was created, in UNIX epoch time format.
Source§impl CreatePoolOutput
impl CreatePoolOutput
Sourcepub fn builder() -> CreatePoolOutputBuilder
pub fn builder() -> CreatePoolOutputBuilder
Creates a new builder-style object to manufacture CreatePoolOutput
.
Trait Implementations§
Source§impl Clone for CreatePoolOutput
impl Clone for CreatePoolOutput
Source§fn clone(&self) -> CreatePoolOutput
fn clone(&self) -> CreatePoolOutput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreatePoolOutput
impl Debug for CreatePoolOutput
Source§impl PartialEq for CreatePoolOutput
impl PartialEq for CreatePoolOutput
Source§impl RequestId for CreatePoolOutput
impl RequestId for CreatePoolOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for CreatePoolOutput
Auto Trait Implementations§
impl Freeze for CreatePoolOutput
impl RefUnwindSafe for CreatePoolOutput
impl Send for CreatePoolOutput
impl Sync for CreatePoolOutput
impl Unpin for CreatePoolOutput
impl UnwindSafe for CreatePoolOutput
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);