pub struct StartConversationFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to StartConversation.
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2 processes the incoming events and responds with streaming text or audio events.
Audio input must be in the following format: audio/lpcm sample-rate=8000 sample-size-bits=16 channel-count=1; is-big-endian=false.
If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.
-
Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.
-
Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.
-
Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.
For more information, see Completion message.
If the optional update message is configured, it is played at the specified frequency while the Lambda function is running and the update message state is active. If the fulfillment update message is not active, the Lambda function runs with a 30 second timeout.
For more information, see Update message
The StartConversation operation is supported only in the following SDKs:
Implementations§
Source§impl StartConversationFluentBuilder
impl StartConversationFluentBuilder
Sourcepub fn as_input(&self) -> &StartConversationInputBuilder
pub fn as_input(&self) -> &StartConversationInputBuilder
Access the StartConversation as a reference.
Sourcepub async fn send(
self,
) -> Result<StartConversationOutput, SdkError<StartConversationError, HttpResponse>>
pub async fn send( self, ) -> Result<StartConversationOutput, SdkError<StartConversationError, 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<StartConversationOutput, StartConversationError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartConversationOutput, StartConversationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn bot_id(self, input: impl Into<String>) -> Self
pub fn bot_id(self, input: impl Into<String>) -> Self
The identifier of the bot to process the request.
Sourcepub fn set_bot_id(self, input: Option<String>) -> Self
pub fn set_bot_id(self, input: Option<String>) -> Self
The identifier of the bot to process the request.
Sourcepub fn get_bot_id(&self) -> &Option<String>
pub fn get_bot_id(&self) -> &Option<String>
The identifier of the bot to process the request.
Sourcepub fn bot_alias_id(self, input: impl Into<String>) -> Self
pub fn bot_alias_id(self, input: impl Into<String>) -> Self
The alias identifier in use for the bot that processes the request.
Sourcepub fn set_bot_alias_id(self, input: Option<String>) -> Self
pub fn set_bot_alias_id(self, input: Option<String>) -> Self
The alias identifier in use for the bot that processes the request.
Sourcepub fn get_bot_alias_id(&self) -> &Option<String>
pub fn get_bot_alias_id(&self) -> &Option<String>
The alias identifier in use for the bot that processes the request.
Sourcepub fn locale_id(self, input: impl Into<String>) -> Self
pub fn locale_id(self, input: impl Into<String>) -> Self
The locale where the session is in use.
Sourcepub fn set_locale_id(self, input: Option<String>) -> Self
pub fn set_locale_id(self, input: Option<String>) -> Self
The locale where the session is in use.
Sourcepub fn get_locale_id(&self) -> &Option<String>
pub fn get_locale_id(&self) -> &Option<String>
The locale where the session is in use.
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The identifier of the user session that is having the conversation.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The identifier of the user session that is having the conversation.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The identifier of the user session that is having the conversation.
Sourcepub fn conversation_mode(self, input: ConversationMode) -> Self
pub fn conversation_mode(self, input: ConversationMode) -> Self
The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.
Sourcepub fn set_conversation_mode(self, input: Option<ConversationMode>) -> Self
pub fn set_conversation_mode(self, input: Option<ConversationMode>) -> Self
The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.
Sourcepub fn get_conversation_mode(&self) -> &Option<ConversationMode>
pub fn get_conversation_mode(&self) -> &Option<ConversationMode>
The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.
Sourcepub fn request_event_stream(
self,
input: EventStreamSender<StartConversationRequestEventStream, StartConversationRequestEventStreamError>,
) -> Self
pub fn request_event_stream( self, input: EventStreamSender<StartConversationRequestEventStream, StartConversationRequestEventStreamError>, ) -> Self
Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.
Sourcepub fn set_request_event_stream(
self,
input: Option<EventStreamSender<StartConversationRequestEventStream, StartConversationRequestEventStreamError>>,
) -> Self
pub fn set_request_event_stream( self, input: Option<EventStreamSender<StartConversationRequestEventStream, StartConversationRequestEventStreamError>>, ) -> Self
Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.
Sourcepub fn get_request_event_stream(
&self,
) -> &Option<EventStreamSender<StartConversationRequestEventStream, StartConversationRequestEventStreamError>>
pub fn get_request_event_stream( &self, ) -> &Option<EventStreamSender<StartConversationRequestEventStream, StartConversationRequestEventStreamError>>
Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for StartConversationFluentBuilder
impl !RefUnwindSafe for StartConversationFluentBuilder
impl Send for StartConversationFluentBuilder
impl Sync for StartConversationFluentBuilder
impl Unpin for StartConversationFluentBuilder
impl !UnwindSafe for StartConversationFluentBuilder
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);