pub struct GetChannelMessageStatusFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to GetChannelMessageStatus.
Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.
Messages can have any one of these statuses.
- SENT
-
Message processed successfully
- PENDING
-
Ongoing processing
- FAILED
-
Processing failed
- DENIED
-
Message denied by the processor
-
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
-
Only the message sender can invoke this API.
-
The
x-amz-chime-bearerrequest header is mandatory. Use the ARN of theAppInstanceUserorAppInstanceBotthat makes the API call as the value in the header.
Implementations§
Source§impl GetChannelMessageStatusFluentBuilder
impl GetChannelMessageStatusFluentBuilder
Sourcepub fn as_input(&self) -> &GetChannelMessageStatusInputBuilder
pub fn as_input(&self) -> &GetChannelMessageStatusInputBuilder
Access the GetChannelMessageStatus as a reference.
Sourcepub async fn send(
self,
) -> Result<GetChannelMessageStatusOutput, SdkError<GetChannelMessageStatusError, HttpResponse>>
pub async fn send( self, ) -> Result<GetChannelMessageStatusOutput, SdkError<GetChannelMessageStatusError, 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<GetChannelMessageStatusOutput, GetChannelMessageStatusError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetChannelMessageStatusOutput, GetChannelMessageStatusError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn channel_arn(self, input: impl Into<String>) -> Self
pub fn channel_arn(self, input: impl Into<String>) -> Self
The ARN of the channel
Sourcepub fn set_channel_arn(self, input: Option<String>) -> Self
pub fn set_channel_arn(self, input: Option<String>) -> Self
The ARN of the channel
Sourcepub fn get_channel_arn(&self) -> &Option<String>
pub fn get_channel_arn(&self) -> &Option<String>
The ARN of the channel
Sourcepub fn message_id(self, input: impl Into<String>) -> Self
pub fn message_id(self, input: impl Into<String>) -> Self
The ID of the message.
Sourcepub fn set_message_id(self, input: Option<String>) -> Self
pub fn set_message_id(self, input: Option<String>) -> Self
The ID of the message.
Sourcepub fn get_message_id(&self) -> &Option<String>
pub fn get_message_id(&self) -> &Option<String>
The ID of the message.
Sourcepub fn chime_bearer(self, input: impl Into<String>) -> Self
pub fn chime_bearer(self, input: impl Into<String>) -> Self
The AppInstanceUserArn of the user making the API call.
Sourcepub fn set_chime_bearer(self, input: Option<String>) -> Self
pub fn set_chime_bearer(self, input: Option<String>) -> Self
The AppInstanceUserArn of the user making the API call.
Sourcepub fn get_chime_bearer(&self) -> &Option<String>
pub fn get_chime_bearer(&self) -> &Option<String>
The AppInstanceUserArn of the user making the API call.
Sourcepub fn sub_channel_id(self, input: impl Into<String>) -> Self
pub fn sub_channel_id(self, input: impl Into<String>) -> Self
The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.
Sourcepub fn set_sub_channel_id(self, input: Option<String>) -> Self
pub fn set_sub_channel_id(self, input: Option<String>) -> Self
The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.
Sourcepub fn get_sub_channel_id(&self) -> &Option<String>
pub fn get_sub_channel_id(&self) -> &Option<String>
The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.
Trait Implementations§
Source§impl Clone for GetChannelMessageStatusFluentBuilder
impl Clone for GetChannelMessageStatusFluentBuilder
Source§fn clone(&self) -> GetChannelMessageStatusFluentBuilder
fn clone(&self) -> GetChannelMessageStatusFluentBuilder
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 GetChannelMessageStatusFluentBuilder
impl !RefUnwindSafe for GetChannelMessageStatusFluentBuilder
impl Send for GetChannelMessageStatusFluentBuilder
impl Sync for GetChannelMessageStatusFluentBuilder
impl Unpin for GetChannelMessageStatusFluentBuilder
impl !UnwindSafe for GetChannelMessageStatusFluentBuilder
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);