Package software.amazon.awssdk.services.lexruntimev2.model

Class ConfigurationEvent.BuilderImpl

    • Constructor Detail

      • BuilderImpl

        protected BuilderImpl()

    • Method Detail

      • getRequestAttributes

        public final Map<String,​String> getRequestAttributes()

      • setRequestAttributes

        public final void setRequestAttributes​(Map<String,​String> requestAttributes)

      • requestAttributes

        public final ConfigurationEvent.Builder requestAttributes​(Map<String,​String> requestAttributes)
        Description copied from interface: ConfigurationEvent.Builder

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

        Specified by:
        requestAttributes in interface ConfigurationEvent.Builder
        Parameters:
        requestAttributes - 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:.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • getResponseContentType

        public final String getResponseContentType()

      • setResponseContentType

        public final void setResponseContentType​(String responseContentType)

      • responseContentType

        public final ConfigurationEvent.Builder responseContentType​(String responseContentType)
        Description copied from interface: ConfigurationEvent.Builder

        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

        Specified by:
        responseContentType in interface ConfigurationEvent.Builder
        Parameters:
        responseContentType - 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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setSessionState

        public final void setSessionState​(software.amazon.awssdk.services.lexruntimev2.model.SessionState.BuilderImpl sessionState)

      • setWelcomeMessages

        public final void setWelcomeMessages​(Collection<software.amazon.awssdk.services.lexruntimev2.model.Message.BuilderImpl> welcomeMessages)

      • getDisablePlayback

        public final Boolean getDisablePlayback()

      • setDisablePlayback

        public final void setDisablePlayback​(Boolean disablePlayback)

      • disablePlayback

        public final ConfigurationEvent.Builder disablePlayback​(Boolean disablePlayback)
        Description copied from interface: ConfigurationEvent.Builder

        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.

        Specified by:
        disablePlayback in interface ConfigurationEvent.Builder
        Parameters:
        disablePlayback - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • getEventId

        public final String getEventId()

      • setEventId

        public final void setEventId​(String eventId)

      • eventId

        public final ConfigurationEvent.Builder eventId​(String eventId)
        Description copied from interface: ConfigurationEvent.Builder

        A unique identifier that your application assigns to the event. You can use this to identify events in logs.

        Specified by:
        eventId in interface ConfigurationEvent.Builder
        Parameters:
        eventId - A unique identifier that your application assigns to the event. You can use this to identify events in logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • getClientTimestampMillis

        public final Long getClientTimestampMillis()

      • setClientTimestampMillis

        public final void setClientTimestampMillis​(Long clientTimestampMillis)

      • clientTimestampMillis

        public final ConfigurationEvent.Builder clientTimestampMillis​(Long clientTimestampMillis)
        Description copied from interface: ConfigurationEvent.Builder

        A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

        Specified by:
        clientTimestampMillis in interface ConfigurationEvent.Builder
        Parameters:
        clientTimestampMillis - A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.