Package software.amazon.awssdk.services.bedrockagentruntime.model

Class FlowOutputEvent

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FlowOutputEvent

All Implemented Interfaces:

Serializable, SdkPojo, FlowResponseStream, ToCopyableBuilder<FlowOutputEvent.Builder,FlowOutputEvent>

Direct Known Subclasses:

DefaultFlowOutputEvent

@Generated("software.amazon.awssdk:codegen")
public class FlowOutputEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FlowOutputEvent.Builder,FlowOutputEvent>, FlowResponseStream

Contains information about an output from prompt flow invoction.

This data type is used in the following API operations:

• InvokeFlow response

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlowOutputEvent.Builder
protected static class	FlowOutputEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.FlowResponseStream

FlowResponseStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.FlowResponseStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FlowOutputEvent(FlowOutputEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(InvokeFlowResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of FlowOutputEvent.
static FlowOutputEvent.Builder	builder()
FlowOutputContent	content()	The content in the output.
FlowOutputEvent	copy(Consumer<? super FlowOutputEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	nodeName()	The name of the flow output node that the output is from.
NodeType	nodeType()	The type of the node that the output is from.
String	nodeTypeAsString()	The type of the node that the output is from.
List<SdkField<?>>	sdkFields()
static Class<? extends FlowOutputEvent.Builder>	serializableBuilderClass()
FlowOutputEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.FlowResponseStream

sdkEventType

Constructor Detail

FlowOutputEvent

protected FlowOutputEvent(FlowOutputEvent.BuilderImpl builder)

Method Detail

content

public final FlowOutputContent content()

The content in the output.

Returns:

The content in the output.

nodeName

public final String nodeName()

The name of the flow output node that the output is from.

Returns:

The name of the flow output node that the output is from.

nodeType

public final NodeType nodeType()

The type of the node that the output is from.

If the service returns an enum value that is not available in the current SDK version, nodeType will return NodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nodeTypeAsString().

Returns:

The type of the node that the output is from.

See Also:

NodeType

nodeTypeAsString

public final String nodeTypeAsString()

The type of the node that the output is from.

If the service returns an enum value that is not available in the current SDK version, nodeType will return NodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nodeTypeAsString().

Returns:

The type of the node that the output is from.

See Also:

NodeType

toBuilder

public FlowOutputEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FlowOutputEvent.Builder,FlowOutputEvent>

builder

public static FlowOutputEvent.Builder builder()

serializableBuilderClass

public static Class<? extends FlowOutputEvent.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

copy

public final FlowOutputEvent copy(Consumer<? super FlowOutputEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<FlowOutputEvent.Builder,FlowOutputEvent>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(InvokeFlowResponseHandler.Visitor visitor)

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

Specified by:

accept in interface FlowResponseStream

Parameters:

visitor - Visitor to invoke.