qbusiness/aws.sdk.kotlin.services.qbusiness.model/ChatInputStream

ChatInputStream

sealed class ChatInputStream

The streaming input for the Chat API.

Inheritors

ActionExecutionEvent

AttachmentEvent

AuthChallengeResponseEvent

Types

ActionExecutionEvent

data class ActionExecutionEvent(val value: ActionExecutionEvent) : ChatInputStream

A request from an end user to perform an Amazon Q Business plugin action.

AttachmentEvent

data class AttachmentEvent(val value: AttachmentInputEvent) : ChatInputStream

A request by an end user to upload a file during chat.

AuthChallengeResponseEvent

data class AuthChallengeResponseEvent(val value: AuthChallengeResponseEvent) : ChatInputStream

An authentication verification event response by a third party authentication server to Amazon Q Business.

ConfigurationEvent

data class ConfigurationEvent(val value: ConfigurationEvent) : ChatInputStream

A configuration event activated by an end user request to select a specific chat mode.

EndOfInputEvent

data class EndOfInputEvent(val value: EndOfInputEvent) : ChatInputStream

The end of the streaming input for the Chat API.

SdkUnknown

object SdkUnknown : ChatInputStream

TextEvent

data class TextEvent(val value: TextInputEvent) : ChatInputStream

Information about the payload of the ChatInputStream event containing the end user message input.

Functions

asActionExecutionEvent

fun asActionExecutionEvent(): ActionExecutionEvent

Casts this ChatInputStream as a ActionExecutionEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.ActionExecutionEvent value. Throws an exception if the ChatInputStream is not a ActionExecutionEvent.

asActionExecutionEventOrNull

fun asActionExecutionEventOrNull(): ActionExecutionEvent?

Casts this ChatInputStream as a ActionExecutionEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.ActionExecutionEvent value. Returns null if the ChatInputStream is not a ActionExecutionEvent.

asAttachmentEvent

fun asAttachmentEvent(): AttachmentInputEvent

Casts this ChatInputStream as a AttachmentEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.AttachmentInputEvent value. Throws an exception if the ChatInputStream is not a AttachmentEvent.

asAttachmentEventOrNull

fun asAttachmentEventOrNull(): AttachmentInputEvent?

Casts this ChatInputStream as a AttachmentEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.AttachmentInputEvent value. Returns null if the ChatInputStream is not a AttachmentEvent.

asAuthChallengeResponseEvent

fun asAuthChallengeResponseEvent(): AuthChallengeResponseEvent

Casts this ChatInputStream as a AuthChallengeResponseEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.AuthChallengeResponseEvent value. Throws an exception if the ChatInputStream is not a AuthChallengeResponseEvent.

asAuthChallengeResponseEventOrNull

fun asAuthChallengeResponseEventOrNull(): AuthChallengeResponseEvent?

Casts this ChatInputStream as a AuthChallengeResponseEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.AuthChallengeResponseEvent value. Returns null if the ChatInputStream is not a AuthChallengeResponseEvent.

asConfigurationEvent

fun asConfigurationEvent(): ConfigurationEvent

Casts this ChatInputStream as a ConfigurationEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.ConfigurationEvent value. Throws an exception if the ChatInputStream is not a ConfigurationEvent.

asConfigurationEventOrNull

fun asConfigurationEventOrNull(): ConfigurationEvent?

Casts this ChatInputStream as a ConfigurationEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.ConfigurationEvent value. Returns null if the ChatInputStream is not a ConfigurationEvent.

asEndOfInputEvent

fun asEndOfInputEvent(): EndOfInputEvent

Casts this ChatInputStream as a EndOfInputEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.EndOfInputEvent value. Throws an exception if the ChatInputStream is not a EndOfInputEvent.

asEndOfInputEventOrNull

fun asEndOfInputEventOrNull(): EndOfInputEvent?

Casts this ChatInputStream as a EndOfInputEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.EndOfInputEvent value. Returns null if the ChatInputStream is not a EndOfInputEvent.

asTextEvent

fun asTextEvent(): TextInputEvent

Casts this ChatInputStream as a TextEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.TextInputEvent value. Throws an exception if the ChatInputStream is not a TextEvent.

asTextEventOrNull

fun asTextEventOrNull(): TextInputEvent?

Casts this ChatInputStream as a TextEvent and retrieves its aws.sdk.kotlin.services.qbusiness.model.TextInputEvent value. Returns null if the ChatInputStream is not a TextEvent.