#[non_exhaustive]pub struct PutSessionInputBuilder { /* private fields */ }
Expand description
A builder for PutSessionInput
.
Implementations§
Source§impl PutSessionInputBuilder
impl PutSessionInputBuilder
Sourcepub fn bot_name(self, input: impl Into<String>) -> Self
pub fn bot_name(self, input: impl Into<String>) -> Self
The name of the bot that contains the session data.
This field is required.Sourcepub fn set_bot_name(self, input: Option<String>) -> Self
pub fn set_bot_name(self, input: Option<String>) -> Self
The name of the bot that contains the session data.
Sourcepub fn get_bot_name(&self) -> &Option<String>
pub fn get_bot_name(&self) -> &Option<String>
The name of the bot that contains the session data.
Sourcepub fn bot_alias(self, input: impl Into<String>) -> Self
pub fn bot_alias(self, input: impl Into<String>) -> Self
The alias in use for the bot that contains the session data.
This field is required.Sourcepub fn set_bot_alias(self, input: Option<String>) -> Self
pub fn set_bot_alias(self, input: Option<String>) -> Self
The alias in use for the bot that contains the session data.
Sourcepub fn get_bot_alias(&self) -> &Option<String>
pub fn get_bot_alias(&self) -> &Option<String>
The alias in use for the bot that contains the session data.
Sourcepub fn user_id(self, input: impl Into<String>) -> Self
pub fn user_id(self, input: impl Into<String>) -> Self
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
This field is required.Sourcepub fn set_user_id(self, input: Option<String>) -> Self
pub fn set_user_id(self, input: Option<String>) -> Self
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
Sourcepub fn get_user_id(&self) -> &Option<String>
pub fn get_user_id(&self) -> &Option<String>
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
Sourcepub fn session_attributes(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn session_attributes( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to session_attributes
.
To override the contents of this collection use set_session_attributes
.
Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
Sourcepub fn set_session_attributes(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_session_attributes( self, input: Option<HashMap<String, String>>, ) -> Self
Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
Sourcepub fn get_session_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_session_attributes(&self) -> &Option<HashMap<String, String>>
Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
Sourcepub fn dialog_action(self, input: DialogAction) -> Self
pub fn dialog_action(self, input: DialogAction) -> Self
Sets the next action that the bot should take to fulfill the conversation.
Sourcepub fn set_dialog_action(self, input: Option<DialogAction>) -> Self
pub fn set_dialog_action(self, input: Option<DialogAction>) -> Self
Sets the next action that the bot should take to fulfill the conversation.
Sourcepub fn get_dialog_action(&self) -> &Option<DialogAction>
pub fn get_dialog_action(&self) -> &Option<DialogAction>
Sets the next action that the bot should take to fulfill the conversation.
Sourcepub fn recent_intent_summary_view(self, input: IntentSummary) -> Self
pub fn recent_intent_summary_view(self, input: IntentSummary) -> Self
Appends an item to recent_intent_summary_view
.
To override the contents of this collection use set_recent_intent_summary_view
.
A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.
An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:
-
intentName
-
slot names
-
slotToElict
If you send the recentIntentSummaryView
parameter in a PutSession
request, the contents of the new summary view replaces the old summary view. For example, if a GetSession
request returns three intents in the summary view and you call PutSession
with one intent in the summary view, the next call to GetSession
will only return one intent.
Sourcepub fn set_recent_intent_summary_view(
self,
input: Option<Vec<IntentSummary>>,
) -> Self
pub fn set_recent_intent_summary_view( self, input: Option<Vec<IntentSummary>>, ) -> Self
A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.
An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:
-
intentName
-
slot names
-
slotToElict
If you send the recentIntentSummaryView
parameter in a PutSession
request, the contents of the new summary view replaces the old summary view. For example, if a GetSession
request returns three intents in the summary view and you call PutSession
with one intent in the summary view, the next call to GetSession
will only return one intent.
Sourcepub fn get_recent_intent_summary_view(&self) -> &Option<Vec<IntentSummary>>
pub fn get_recent_intent_summary_view(&self) -> &Option<Vec<IntentSummary>>
A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.
An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:
-
intentName
-
slot names
-
slotToElict
If you send the recentIntentSummaryView
parameter in a PutSession
request, the contents of the new summary view replaces the old summary view. For example, if a GetSession
request returns three intents in the summary view and you call PutSession
with one intent in the summary view, the next call to GetSession
will only return one intent.
Sourcepub fn accept(self, input: impl Into<String>) -> Self
pub fn accept(self, input: impl Into<String>) -> Self
The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
-
If the value is
text/plain; charset=utf-8
, Amazon Lex returns text in the response. -
If the value begins with
audio/
, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specifyaudio/mpeg
as the value, Amazon Lex returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech is returned asaudio/pcm
in 16-bit, little endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm
-
audio/*
(defaults to mpeg) -
text/plain; charset=utf-8
-
Sourcepub fn set_accept(self, input: Option<String>) -> Self
pub fn set_accept(self, input: Option<String>) -> Self
The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
-
If the value is
text/plain; charset=utf-8
, Amazon Lex returns text in the response. -
If the value begins with
audio/
, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specifyaudio/mpeg
as the value, Amazon Lex returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech is returned asaudio/pcm
in 16-bit, little endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm
-
audio/*
(defaults to mpeg) -
text/plain; charset=utf-8
-
Sourcepub fn get_accept(&self) -> &Option<String>
pub fn get_accept(&self) -> &Option<String>
The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
-
If the value is
text/plain; charset=utf-8
, Amazon Lex returns text in the response. -
If the value begins with
audio/
, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specifyaudio/mpeg
as the value, Amazon Lex returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech is returned asaudio/pcm
in 16-bit, little endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm
-
audio/*
(defaults to mpeg) -
text/plain; charset=utf-8
-
Sourcepub fn active_contexts(self, input: ActiveContext) -> Self
pub fn active_contexts(self, input: ActiveContext) -> Self
Appends an item to active_contexts
.
To override the contents of this collection use set_active_contexts
.
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
Sourcepub fn set_active_contexts(self, input: Option<Vec<ActiveContext>>) -> Self
pub fn set_active_contexts(self, input: Option<Vec<ActiveContext>>) -> Self
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
Sourcepub fn get_active_contexts(&self) -> &Option<Vec<ActiveContext>>
pub fn get_active_contexts(&self) -> &Option<Vec<ActiveContext>>
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
Sourcepub fn build(self) -> Result<PutSessionInput, BuildError>
pub fn build(self) -> Result<PutSessionInput, BuildError>
Consumes the builder and constructs a PutSessionInput
.
Source§impl PutSessionInputBuilder
impl PutSessionInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<PutSessionOutput, SdkError<PutSessionError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<PutSessionOutput, SdkError<PutSessionError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for PutSessionInputBuilder
impl Clone for PutSessionInputBuilder
Source§fn clone(&self) -> PutSessionInputBuilder
fn clone(&self) -> PutSessionInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PutSessionInputBuilder
impl Debug for PutSessionInputBuilder
Source§impl Default for PutSessionInputBuilder
impl Default for PutSessionInputBuilder
Source§fn default() -> PutSessionInputBuilder
fn default() -> PutSessionInputBuilder
Source§impl PartialEq for PutSessionInputBuilder
impl PartialEq for PutSessionInputBuilder
impl StructuralPartialEq for PutSessionInputBuilder
Auto Trait Implementations§
impl Freeze for PutSessionInputBuilder
impl RefUnwindSafe for PutSessionInputBuilder
impl Send for PutSessionInputBuilder
impl Sync for PutSessionInputBuilder
impl Unpin for PutSessionInputBuilder
impl UnwindSafe for PutSessionInputBuilder
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);