#[non_exhaustive]pub struct ChatInputBuilder { /* private fields */ }Expand description
A builder for ChatInput.
Implementations§
Source§impl ChatInputBuilder
impl ChatInputBuilder
Sourcepub fn application_id(self, input: impl Into<String>) -> Self
pub fn application_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
This field is required.Sourcepub fn set_application_id(self, input: Option<String>) -> Self
pub fn set_application_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
Sourcepub fn get_application_id(&self) -> &Option<String>
pub fn get_application_id(&self) -> &Option<String>
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
Sourcepub fn user_id(self, input: impl Into<String>) -> Self
pub fn user_id(self, input: impl Into<String>) -> Self
The identifier of the user attached to the chat input.
Sourcepub fn set_user_id(self, input: Option<String>) -> Self
pub fn set_user_id(self, input: Option<String>) -> Self
The identifier of the user attached to the chat input.
Sourcepub fn get_user_id(&self) -> &Option<String>
pub fn get_user_id(&self) -> &Option<String>
The identifier of the user attached to the chat input.
Sourcepub fn user_groups(self, input: impl Into<String>) -> Self
pub fn user_groups(self, input: impl Into<String>) -> Self
Appends an item to user_groups.
To override the contents of this collection use set_user_groups.
The group names that a user associated with the chat input belongs to.
Sourcepub fn set_user_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_user_groups(self, input: Option<Vec<String>>) -> Self
The group names that a user associated with the chat input belongs to.
Sourcepub fn get_user_groups(&self) -> &Option<Vec<String>>
pub fn get_user_groups(&self) -> &Option<Vec<String>>
The group names that a user associated with the chat input belongs to.
Sourcepub fn conversation_id(self, input: impl Into<String>) -> Self
pub fn conversation_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q Business conversation.
Sourcepub fn set_conversation_id(self, input: Option<String>) -> Self
pub fn set_conversation_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q Business conversation.
Sourcepub fn get_conversation_id(&self) -> &Option<String>
pub fn get_conversation_id(&self) -> &Option<String>
The identifier of the Amazon Q Business conversation.
Sourcepub fn parent_message_id(self, input: impl Into<String>) -> Self
pub fn parent_message_id(self, input: impl Into<String>) -> Self
The identifier used to associate a user message with a AI generated response.
Sourcepub fn set_parent_message_id(self, input: Option<String>) -> Self
pub fn set_parent_message_id(self, input: Option<String>) -> Self
The identifier used to associate a user message with a AI generated response.
Sourcepub fn get_parent_message_id(&self) -> &Option<String>
pub fn get_parent_message_id(&self) -> &Option<String>
The identifier used to associate a user message with a AI generated response.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token that you provide to identify the chat input.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token that you provide to identify the chat input.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token that you provide to identify the chat input.
Sourcepub fn input_stream(
self,
input: EventStreamSender<ChatInputStream, ChatInputStreamError>,
) -> Self
pub fn input_stream( self, input: EventStreamSender<ChatInputStream, ChatInputStreamError>, ) -> Self
The streaming input for the Chat API.
Sourcepub fn set_input_stream(
self,
input: Option<EventStreamSender<ChatInputStream, ChatInputStreamError>>,
) -> Self
pub fn set_input_stream( self, input: Option<EventStreamSender<ChatInputStream, ChatInputStreamError>>, ) -> Self
The streaming input for the Chat API.
Sourcepub fn get_input_stream(
&self,
) -> &Option<EventStreamSender<ChatInputStream, ChatInputStreamError>>
pub fn get_input_stream( &self, ) -> &Option<EventStreamSender<ChatInputStream, ChatInputStreamError>>
The streaming input for the Chat API.
Source§impl ChatInputBuilder
impl ChatInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ChatOutput, SdkError<ChatError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ChatOutput, SdkError<ChatError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Debug for ChatInputBuilder
impl Debug for ChatInputBuilder
Source§impl Default for ChatInputBuilder
impl Default for ChatInputBuilder
Source§fn default() -> ChatInputBuilder
fn default() -> ChatInputBuilder
Auto Trait Implementations§
impl Freeze for ChatInputBuilder
impl !RefUnwindSafe for ChatInputBuilder
impl Send for ChatInputBuilder
impl Sync for ChatInputBuilder
impl Unpin for ChatInputBuilder
impl !UnwindSafe for ChatInputBuilder
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> 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);