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

Class FlowExecutionEvent

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.FlowExecutionEvent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FlowExecutionEvent.Builder,FlowExecutionEvent>

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

Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlowExecutionEvent.Builder
static class	FlowExecutionEvent.Type

Method Summary

Modifier and Type	Method	Description
static FlowExecutionEvent.Builder	builder()
ConditionResultEvent	conditionResultEvent()	Contains information about a condition evaluation result during the flow execution.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FlowFailureEvent	flowFailureEvent()	Contains information about a failure that occurred at the flow level during execution.
FlowExecutionInputEvent	flowInputEvent()	Contains information about the inputs provided to the flow at the start of execution.
FlowExecutionOutputEvent	flowOutputEvent()	Contains information about the outputs produced by the flow at the end of execution.
static FlowExecutionEvent	fromConditionResultEvent(Consumer<ConditionResultEvent.Builder> conditionResultEvent)	Create an instance of this class with conditionResultEvent() initialized to the given value.
static FlowExecutionEvent	fromConditionResultEvent(ConditionResultEvent conditionResultEvent)	Create an instance of this class with conditionResultEvent() initialized to the given value.
static FlowExecutionEvent	fromFlowFailureEvent(Consumer<FlowFailureEvent.Builder> flowFailureEvent)	Create an instance of this class with flowFailureEvent() initialized to the given value.
static FlowExecutionEvent	fromFlowFailureEvent(FlowFailureEvent flowFailureEvent)	Create an instance of this class with flowFailureEvent() initialized to the given value.
static FlowExecutionEvent	fromFlowInputEvent(Consumer<FlowExecutionInputEvent.Builder> flowInputEvent)	Create an instance of this class with flowInputEvent() initialized to the given value.
static FlowExecutionEvent	fromFlowInputEvent(FlowExecutionInputEvent flowInputEvent)	Create an instance of this class with flowInputEvent() initialized to the given value.
static FlowExecutionEvent	fromFlowOutputEvent(Consumer<FlowExecutionOutputEvent.Builder> flowOutputEvent)	Create an instance of this class with flowOutputEvent() initialized to the given value.
static FlowExecutionEvent	fromFlowOutputEvent(FlowExecutionOutputEvent flowOutputEvent)	Create an instance of this class with flowOutputEvent() initialized to the given value.
static FlowExecutionEvent	fromNodeFailureEvent(Consumer<NodeFailureEvent.Builder> nodeFailureEvent)	Create an instance of this class with nodeFailureEvent() initialized to the given value.
static FlowExecutionEvent	fromNodeFailureEvent(NodeFailureEvent nodeFailureEvent)	Create an instance of this class with nodeFailureEvent() initialized to the given value.
static FlowExecutionEvent	fromNodeInputEvent(Consumer<NodeInputEvent.Builder> nodeInputEvent)	Create an instance of this class with nodeInputEvent() initialized to the given value.
static FlowExecutionEvent	fromNodeInputEvent(NodeInputEvent nodeInputEvent)	Create an instance of this class with nodeInputEvent() initialized to the given value.
static FlowExecutionEvent	fromNodeOutputEvent(Consumer<NodeOutputEvent.Builder> nodeOutputEvent)	Create an instance of this class with nodeOutputEvent() initialized to the given value.
static FlowExecutionEvent	fromNodeOutputEvent(NodeOutputEvent nodeOutputEvent)	Create an instance of this class with nodeOutputEvent() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NodeFailureEvent	nodeFailureEvent()	Contains information about a failure that occurred at a specific node during execution.
NodeInputEvent	nodeInputEvent()	Contains information about the inputs provided to a specific node during execution.
NodeOutputEvent	nodeOutputEvent()	Contains information about the outputs produced by a specific node during execution.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FlowExecutionEvent.Builder>	serializableBuilderClass()
FlowExecutionEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
FlowExecutionEvent.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

conditionResultEvent

public final ConditionResultEvent conditionResultEvent()

Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

Returns:

Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

flowFailureEvent

public final FlowFailureEvent flowFailureEvent()

Contains information about a failure that occurred at the flow level during execution.

Returns:

Contains information about a failure that occurred at the flow level during execution.

flowInputEvent

public final FlowExecutionInputEvent flowInputEvent()

Contains information about the inputs provided to the flow at the start of execution.

Returns:

Contains information about the inputs provided to the flow at the start of execution.

flowOutputEvent

public final FlowExecutionOutputEvent flowOutputEvent()

Contains information about the outputs produced by the flow at the end of execution.

Returns:

Contains information about the outputs produced by the flow at the end of execution.

nodeFailureEvent

public final NodeFailureEvent nodeFailureEvent()

Contains information about a failure that occurred at a specific node during execution.

Returns:

Contains information about a failure that occurred at a specific node during execution.

nodeInputEvent

public final NodeInputEvent nodeInputEvent()

Contains information about the inputs provided to a specific node during execution.

Returns:

Contains information about the inputs provided to a specific node during execution.

nodeOutputEvent

public final NodeOutputEvent nodeOutputEvent()

Contains information about the outputs produced by a specific node during execution.

Returns:

Contains information about the outputs produced by a specific node during execution.

toBuilder

public FlowExecutionEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FlowExecutionEvent.Builder,FlowExecutionEvent>

builder

public static FlowExecutionEvent.Builder builder()

serializableBuilderClass

public static Class<? extends FlowExecutionEvent.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)

fromConditionResultEvent

public static FlowExecutionEvent fromConditionResultEvent(ConditionResultEvent conditionResultEvent)

Create an instance of this class with conditionResultEvent() initialized to the given value.

Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

Parameters:

conditionResultEvent - Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

fromConditionResultEvent

public static FlowExecutionEvent fromConditionResultEvent(Consumer<ConditionResultEvent.Builder> conditionResultEvent)

Create an instance of this class with conditionResultEvent() initialized to the given value.

Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

Parameters:

conditionResultEvent - Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

fromFlowFailureEvent

public static FlowExecutionEvent fromFlowFailureEvent(FlowFailureEvent flowFailureEvent)

Create an instance of this class with flowFailureEvent() initialized to the given value.

Contains information about a failure that occurred at the flow level during execution.

Parameters:

flowFailureEvent - Contains information about a failure that occurred at the flow level during execution.

fromFlowFailureEvent

public static FlowExecutionEvent fromFlowFailureEvent(Consumer<FlowFailureEvent.Builder> flowFailureEvent)

Create an instance of this class with flowFailureEvent() initialized to the given value.

Contains information about a failure that occurred at the flow level during execution.

Parameters:

flowFailureEvent - Contains information about a failure that occurred at the flow level during execution.

fromFlowInputEvent

public static FlowExecutionEvent fromFlowInputEvent(FlowExecutionInputEvent flowInputEvent)

Create an instance of this class with flowInputEvent() initialized to the given value.

Contains information about the inputs provided to the flow at the start of execution.

Parameters:

flowInputEvent - Contains information about the inputs provided to the flow at the start of execution.

fromFlowInputEvent

public static FlowExecutionEvent fromFlowInputEvent(Consumer<FlowExecutionInputEvent.Builder> flowInputEvent)

Create an instance of this class with flowInputEvent() initialized to the given value.

Contains information about the inputs provided to the flow at the start of execution.

Parameters:

flowInputEvent - Contains information about the inputs provided to the flow at the start of execution.

fromFlowOutputEvent

public static FlowExecutionEvent fromFlowOutputEvent(FlowExecutionOutputEvent flowOutputEvent)

Create an instance of this class with flowOutputEvent() initialized to the given value.

Contains information about the outputs produced by the flow at the end of execution.

Parameters:

flowOutputEvent - Contains information about the outputs produced by the flow at the end of execution.

fromFlowOutputEvent

public static FlowExecutionEvent fromFlowOutputEvent(Consumer<FlowExecutionOutputEvent.Builder> flowOutputEvent)

Create an instance of this class with flowOutputEvent() initialized to the given value.

Contains information about the outputs produced by the flow at the end of execution.

Parameters:

flowOutputEvent - Contains information about the outputs produced by the flow at the end of execution.

fromNodeFailureEvent

public static FlowExecutionEvent fromNodeFailureEvent(NodeFailureEvent nodeFailureEvent)

Create an instance of this class with nodeFailureEvent() initialized to the given value.

Contains information about a failure that occurred at a specific node during execution.

Parameters:

nodeFailureEvent - Contains information about a failure that occurred at a specific node during execution.

fromNodeFailureEvent

public static FlowExecutionEvent fromNodeFailureEvent(Consumer<NodeFailureEvent.Builder> nodeFailureEvent)

Create an instance of this class with nodeFailureEvent() initialized to the given value.

Contains information about a failure that occurred at a specific node during execution.

Parameters:

nodeFailureEvent - Contains information about a failure that occurred at a specific node during execution.

fromNodeInputEvent

public static FlowExecutionEvent fromNodeInputEvent(NodeInputEvent nodeInputEvent)

Create an instance of this class with nodeInputEvent() initialized to the given value.

Contains information about the inputs provided to a specific node during execution.

Parameters:

nodeInputEvent - Contains information about the inputs provided to a specific node during execution.

fromNodeInputEvent

public static FlowExecutionEvent fromNodeInputEvent(Consumer<NodeInputEvent.Builder> nodeInputEvent)

Create an instance of this class with nodeInputEvent() initialized to the given value.

Contains information about the inputs provided to a specific node during execution.

Parameters:

nodeInputEvent - Contains information about the inputs provided to a specific node during execution.

fromNodeOutputEvent

public static FlowExecutionEvent fromNodeOutputEvent(NodeOutputEvent nodeOutputEvent)

Create an instance of this class with nodeOutputEvent() initialized to the given value.

Contains information about the outputs produced by a specific node during execution.

Parameters:

nodeOutputEvent - Contains information about the outputs produced by a specific node during execution.

fromNodeOutputEvent

public static FlowExecutionEvent fromNodeOutputEvent(Consumer<NodeOutputEvent.Builder> nodeOutputEvent)

Create an instance of this class with nodeOutputEvent() initialized to the given value.

Contains information about the outputs produced by a specific node during execution.

Parameters:

nodeOutputEvent - Contains information about the outputs produced by a specific node during execution.

type

public FlowExecutionEvent.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be FlowExecutionEvent.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be FlowExecutionEvent.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo