Interface ChatOutputStream

All Superinterfaces:

SdkPojo

All Known Implementing Classes:

ActionReviewEvent, AuthChallengeRequestEvent, DefaultActionReviewEvent, DefaultAuthChallengeRequestEvent, DefaultFailedAttachmentEvent, DefaultMetadataEvent, DefaultTextEvent, FailedAttachmentEvent, MetadataEvent, TextOutputEvent

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
public interface ChatOutputStream
extends SdkPojo

Base interface for all event types in ChatOutputStream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ChatOutputStream.EventType	The known possible types of events for ChatOutputStream.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatOutputStream	UNKNOWN	Special type of ChatOutputStream for unknown types of events that this version of the SDK does not know about

Method Summary

Modifier and Type	Method	Description
void	accept(ChatResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of ChatOutputStream.
static ActionReviewEvent.Builder	actionReviewEventBuilder()	Create a builder for the actionReviewEvent event type for this stream.
static AuthChallengeRequestEvent.Builder	authChallengeRequestEventBuilder()	Create a builder for the authChallengeRequestEvent event type for this stream.
static FailedAttachmentEvent.Builder	failedAttachmentEventBuilder()	Create a builder for the failedAttachmentEvent event type for this stream.
static MetadataEvent.Builder	metadataEventBuilder()	Create a builder for the metadataEvent event type for this stream.
default ChatOutputStream.EventType	sdkEventType()	The type of this event.
static TextOutputEvent.Builder	textEventBuilder()	Create a builder for the textEvent event type for this stream.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Field Details

UNKNOWN

static final ChatOutputStream UNKNOWN

Special type of ChatOutputStream for unknown types of events that this version of the SDK does not know about

Method Details

textEventBuilder

static TextOutputEvent.Builder textEventBuilder()

Create a builder for the textEvent event type for this stream.

metadataEventBuilder

static MetadataEvent.Builder metadataEventBuilder()

Create a builder for the metadataEvent event type for this stream.

actionReviewEventBuilder

static ActionReviewEvent.Builder actionReviewEventBuilder()

Create a builder for the actionReviewEvent event type for this stream.

failedAttachmentEventBuilder

static FailedAttachmentEvent.Builder failedAttachmentEventBuilder()

Create a builder for the failedAttachmentEvent event type for this stream.

authChallengeRequestEventBuilder

static AuthChallengeRequestEvent.Builder authChallengeRequestEventBuilder()

Create a builder for the authChallengeRequestEvent event type for this stream.

sdkEventType

default ChatOutputStream.EventType sdkEventType()

The type of this event. Corresponds to the :event-type header on the Message.

accept

void accept(ChatResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of ChatOutputStream.

Parameters:

visitor - Visitor to invoke.