Interface ConverseStreamOutput

All Superinterfaces:

SdkPojo

All Known Implementing Classes:

ContentBlockDeltaEvent, ContentBlockStartEvent, ContentBlockStopEvent, ConverseStreamMetadataEvent, DefaultContentBlockDelta, DefaultContentBlockStart, DefaultContentBlockStop, DefaultMessageStart, DefaultMessageStop, DefaultMetadata, MessageStartEvent, MessageStopEvent

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

Base interface for all event types in ConverseStreamOutput.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
void	accept(ConverseStreamResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of ConverseStreamOutput.
static ContentBlockDeltaEvent.Builder	contentBlockDeltaBuilder()	Create a builder for the contentBlockDelta event type for this stream.
static ContentBlockStartEvent.Builder	contentBlockStartBuilder()	Create a builder for the contentBlockStart event type for this stream.
static ContentBlockStopEvent.Builder	contentBlockStopBuilder()	Create a builder for the contentBlockStop event type for this stream.
static MessageStartEvent.Builder	messageStartBuilder()	Create a builder for the messageStart event type for this stream.
static MessageStopEvent.Builder	messageStopBuilder()	Create a builder for the messageStop event type for this stream.
static ConverseStreamMetadataEvent.Builder	metadataBuilder()	Create a builder for the metadata event type for this stream.
default ConverseStreamOutput.EventType	sdkEventType()	The type of this event.

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Field Details

UNKNOWN

static final ConverseStreamOutput UNKNOWN

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

Method Details

messageStartBuilder

static MessageStartEvent.Builder messageStartBuilder()

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

contentBlockStartBuilder

static ContentBlockStartEvent.Builder contentBlockStartBuilder()

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

contentBlockDeltaBuilder

static ContentBlockDeltaEvent.Builder contentBlockDeltaBuilder()

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

contentBlockStopBuilder

static ContentBlockStopEvent.Builder contentBlockStopBuilder()

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

messageStopBuilder

static MessageStopEvent.Builder messageStopBuilder()

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

metadataBuilder

static ConverseStreamMetadataEvent.Builder metadataBuilder()

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

sdkEventType

default ConverseStreamOutput.EventType sdkEventType()

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

accept

void accept(ConverseStreamResponseHandler.Visitor visitor)

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

Parameters:

visitor - Visitor to invoke.