Struct aws_sdk_lexruntime::operation::post_text::builders::PostTextInputBuilder

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

A builder for PostTextInput.

Implementations

impl PostTextInputBuilder

pub fn bot_name(self, input: impl Into<String>) -> Self

The name of the Amazon Lex bot.

This field is required.

pub fn set_bot_name(self, input: Option<String>) -> Self

The name of the Amazon Lex bot.

pub fn get_bot_name(&self) -> &Option<String>

The name of the Amazon Lex bot.

pub fn bot_alias(self, input: impl Into<String>) -> Self

The alias of the Amazon Lex bot.

This field is required.

pub fn set_bot_alias(self, input: Option<String>) -> Self

The alias of the Amazon Lex bot.

pub fn get_bot_alias(&self) -> &Option<String>

The alias of the Amazon Lex bot.

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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

• The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

• If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

• If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

• A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

This field is required.

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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

• The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

• If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

• If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

• A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

• The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

• If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

• If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

• A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

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.

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

pub fn set_session_attributes( self, input: Option<HashMap<String, String>> ) -> Self

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

pub fn get_session_attributes(&self) -> &Option<HashMap<String, String>>

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

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 Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

pub fn set_request_attributes( self, input: Option<HashMap<String, String>> ) -> Self

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

pub fn get_request_attributes(&self) -> &Option<HashMap<String, String>>

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

pub fn input_text(self, input: impl Into<String>) -> Self

The text that the user entered (Amazon Lex interprets this text).

This field is required.

pub fn set_input_text(self, input: Option<String>) -> Self

The text that the user entered (Amazon Lex interprets this text).

pub fn get_input_text(&self) -> &Option<String>

The text that the user entered (Amazon Lex interprets this text).

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.

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.

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.

pub fn build(self) -> Result<PostTextInput, BuildError>

Consumes the builder and constructs a PostTextInput.

impl PostTextInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<PostTextOutput, SdkError<PostTextError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for PostTextInputBuilder

fn clone(&self) -> PostTextInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostTextInputBuilder

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

Formats the value using the given formatter.

impl Default for PostTextInputBuilder

fn default() -> PostTextInputBuilder

Returns the “default value” for a type.

impl PartialEq for PostTextInputBuilder

fn eq(&self, other: &PostTextInputBuilder) -> 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 PostTextInputBuilder