Interface ConverseStreamResponseHandler.Visitor

Enclosing interface:

ConverseStreamResponseHandler

@Generated("software.amazon.awssdk:codegen")
public static interface ConverseStreamResponseHandler.Visitor

Visitor for subtypes of ConverseStreamOutput.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConverseStreamResponseHandler.Visitor.Builder	Builder for ConverseStreamResponseHandler.Visitor.

Method Summary

Modifier and Type	Method	Description
static ConverseStreamResponseHandler.Visitor.Builder	builder()
default void	visitContentBlockDelta(ContentBlockDeltaEvent event)	Invoked when a ContentBlockDeltaEvent is encountered.
default void	visitContentBlockStart(ContentBlockStartEvent event)	Invoked when a ContentBlockStartEvent is encountered.
default void	visitContentBlockStop(ContentBlockStopEvent event)	Invoked when a ContentBlockStopEvent is encountered.
default void	visitDefault(ConverseStreamOutput event)	A required "else" or "default" block, invoked when no other more-specific "visit" method is appropriate.
default void	visitMessageStart(MessageStartEvent event)	Invoked when a MessageStartEvent is encountered.
default void	visitMessageStop(MessageStopEvent event)	Invoked when a MessageStopEvent is encountered.
default void	visitMetadata(ConverseStreamMetadataEvent event)	Invoked when a ConverseStreamMetadataEvent is encountered.

Method Details

builder

static ConverseStreamResponseHandler.Visitor.Builder builder()

Returns:

A new ConverseStreamResponseHandler.Visitor.Builder.

visitDefault

default void visitDefault(ConverseStreamOutput event)

A required "else" or "default" block, invoked when no other more-specific "visit" method is appropriate. This is invoked under two circumstances:

1. The event encountered is newer than the current version of the SDK, so no other more-specific "visit" method could be called. In this case, the provided event will be a generic ConverseStreamOutput. These events can be processed by upgrading the SDK.
2. The event is known by the SDK, but the "visit" was not overridden above. In this case, the provided event will be a specific type of ConverseStreamOutput.

Parameters:

event - The event that was not handled by a more-specific "visit" method.

visitMessageStart

default void visitMessageStart(MessageStartEvent event)

Invoked when a MessageStartEvent is encountered. If this is not overridden, the event will be given to visitDefault(ConverseStreamOutput).

Parameters:

event - Event being visited

visitContentBlockStart

default void visitContentBlockStart(ContentBlockStartEvent event)

Invoked when a ContentBlockStartEvent is encountered. If this is not overridden, the event will be given to visitDefault(ConverseStreamOutput).

Parameters:

event - Event being visited

visitContentBlockDelta

default void visitContentBlockDelta(ContentBlockDeltaEvent event)

Invoked when a ContentBlockDeltaEvent is encountered. If this is not overridden, the event will be given to visitDefault(ConverseStreamOutput).

Parameters:

event - Event being visited

visitContentBlockStop

default void visitContentBlockStop(ContentBlockStopEvent event)

Invoked when a ContentBlockStopEvent is encountered. If this is not overridden, the event will be given to visitDefault(ConverseStreamOutput).

Parameters:

event - Event being visited

visitMessageStop

default void visitMessageStop(MessageStopEvent event)

Invoked when a MessageStopEvent is encountered. If this is not overridden, the event will be given to visitDefault(ConverseStreamOutput).

Parameters:

event - Event being visited

visitMetadata

default void visitMetadata(ConverseStreamMetadataEvent event)

Invoked when a ConverseStreamMetadataEvent is encountered. If this is not overridden, the event will be given to visitDefault(ConverseStreamOutput).

Parameters:

event - Event being visited