#[non_exhaustive]pub struct ConfigurationEventBuilder { /* private fields */ }
Expand description
A builder for ConfigurationEvent
.
Implementations§
Source§impl ConfigurationEventBuilder
impl ConfigurationEventBuilder
Sourcepub fn request_attributes(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn request_attributes( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to request_attributes
.
To override the contents of this collection use set_request_attributes
.
Request-specific information passed between the client application and Amazon Lex V2.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:
.
Sourcepub fn set_request_attributes(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_request_attributes( self, input: Option<HashMap<String, String>>, ) -> Self
Request-specific information passed between the client application and Amazon Lex V2.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:
.
Sourcepub fn get_request_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_request_attributes(&self) -> &Option<HashMap<String, String>>
Request-specific information passed between the client application and Amazon Lex V2.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:
.
Sourcepub fn response_content_type(self, input: impl Into<String>) -> Self
pub fn response_content_type(self, input: impl Into<String>) -> Self
The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType
value.
-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in therequestContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned is audio/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_response_content_type(self, input: Option<String>) -> Self
pub fn set_response_content_type(self, input: Option<String>) -> Self
The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType
value.
-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in therequestContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned is audio/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_response_content_type(&self) -> &Option<String>
pub fn get_response_content_type(&self) -> &Option<String>
The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType
value.
-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in therequestContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned is audio/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 session_state(self, input: SessionState) -> Self
pub fn session_state(self, input: SessionState) -> Self
The state of the user's session with Amazon Lex V2.
Sourcepub fn set_session_state(self, input: Option<SessionState>) -> Self
pub fn set_session_state(self, input: Option<SessionState>) -> Self
The state of the user's session with Amazon Lex V2.
Sourcepub fn get_session_state(&self) -> &Option<SessionState>
pub fn get_session_state(&self) -> &Option<SessionState>
The state of the user's session with Amazon Lex V2.
Sourcepub fn welcome_messages(self, input: Message) -> Self
pub fn welcome_messages(self, input: Message) -> Self
Appends an item to welcome_messages
.
To override the contents of this collection use set_welcome_messages
.
A list of messages to send to the user.
If you set the welcomeMessage
field, you must also set the DialogAction
structure's type
field.
Sourcepub fn set_welcome_messages(self, input: Option<Vec<Message>>) -> Self
pub fn set_welcome_messages(self, input: Option<Vec<Message>>) -> Self
A list of messages to send to the user.
If you set the welcomeMessage
field, you must also set the DialogAction
structure's type
field.
Sourcepub fn get_welcome_messages(&self) -> &Option<Vec<Message>>
pub fn get_welcome_messages(&self) -> &Option<Vec<Message>>
A list of messages to send to the user.
If you set the welcomeMessage
field, you must also set the DialogAction
structure's type
field.
Sourcepub fn disable_playback(self, input: bool) -> Self
pub fn disable_playback(self, input: bool) -> Self
Determines whether Amazon Lex V2 should send audio responses to the client application.
Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.
Sourcepub fn set_disable_playback(self, input: Option<bool>) -> Self
pub fn set_disable_playback(self, input: Option<bool>) -> Self
Determines whether Amazon Lex V2 should send audio responses to the client application.
Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.
Sourcepub fn get_disable_playback(&self) -> &Option<bool>
pub fn get_disable_playback(&self) -> &Option<bool>
Determines whether Amazon Lex V2 should send audio responses to the client application.
Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.
Sourcepub fn event_id(self, input: impl Into<String>) -> Self
pub fn event_id(self, input: impl Into<String>) -> Self
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Sourcepub fn set_event_id(self, input: Option<String>) -> Self
pub fn set_event_id(self, input: Option<String>) -> Self
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Sourcepub fn get_event_id(&self) -> &Option<String>
pub fn get_event_id(&self) -> &Option<String>
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Sourcepub fn client_timestamp_millis(self, input: i64) -> Self
pub fn client_timestamp_millis(self, input: i64) -> Self
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Sourcepub fn set_client_timestamp_millis(self, input: Option<i64>) -> Self
pub fn set_client_timestamp_millis(self, input: Option<i64>) -> Self
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Sourcepub fn get_client_timestamp_millis(&self) -> &Option<i64>
pub fn get_client_timestamp_millis(&self) -> &Option<i64>
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Sourcepub fn build(self) -> Result<ConfigurationEvent, BuildError>
pub fn build(self) -> Result<ConfigurationEvent, BuildError>
Consumes the builder and constructs a ConfigurationEvent
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ConfigurationEventBuilder
impl Clone for ConfigurationEventBuilder
Source§fn clone(&self) -> ConfigurationEventBuilder
fn clone(&self) -> ConfigurationEventBuilder
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 ConfigurationEventBuilder
impl Debug for ConfigurationEventBuilder
Source§impl Default for ConfigurationEventBuilder
impl Default for ConfigurationEventBuilder
Source§fn default() -> ConfigurationEventBuilder
fn default() -> ConfigurationEventBuilder
Source§impl PartialEq for ConfigurationEventBuilder
impl PartialEq for ConfigurationEventBuilder
Source§fn eq(&self, other: &ConfigurationEventBuilder) -> bool
fn eq(&self, other: &ConfigurationEventBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ConfigurationEventBuilder
Auto Trait Implementations§
impl Freeze for ConfigurationEventBuilder
impl RefUnwindSafe for ConfigurationEventBuilder
impl Send for ConfigurationEventBuilder
impl Sync for ConfigurationEventBuilder
impl Unpin for ConfigurationEventBuilder
impl UnwindSafe for ConfigurationEventBuilder
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);