Struct aws_sdk_lexruntimev2::types::builders::ConfigurationEventBuilder

#[non_exhaustive]
pub struct ConfigurationEventBuilder { /* private fields */ }

A builder for ConfigurationEvent.

Implementations

impl ConfigurationEventBuilder

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:.

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:.

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:.

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 the requestContentType parameter. For example, if you specify audio/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

This field is required.

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 the requestContentType parameter. For example, if you specify audio/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

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 the requestContentType parameter. For example, if you specify audio/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

pub fn session_state(self, input: SessionState) -> Self

The state of the user's session with Amazon Lex V2.

pub fn set_session_state(self, input: Option<SessionState>) -> Self

The state of the user's session with Amazon Lex V2.

pub fn get_session_state(&self) -> &Option<SessionState>

The state of the user's session with Amazon Lex V2.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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:

• response_content_type

Trait Implementations

impl Clone for ConfigurationEventBuilder

fn clone(&self) -> ConfigurationEventBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigurationEventBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConfigurationEventBuilder

fn default() -> ConfigurationEventBuilder

Returns the “default value” for a type.

impl PartialEq for ConfigurationEventBuilder

fn eq(&self, other: &ConfigurationEventBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConfigurationEventBuilder