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:

  • Method Details

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • nodeActionEvent

      public final NodeActionEvent nodeActionEvent()

      Contains information about an action (operation) called by a node during execution.

      Returns:
      Contains information about an action (operation) called by a node during execution.

    • nodeDependencyEvent

      public final NodeDependencyEvent nodeDependencyEvent()

      Contains information about an internal trace of a specific node during execution.

      Returns:
      Contains information about an internal trace of a specific node during execution.

    • toBuilder

      public FlowExecutionEvent.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FlowExecutionEvent.Builder,FlowExecutionEvent>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • fromNodeActionEvent

      public static FlowExecutionEvent fromNodeActionEvent(NodeActionEvent nodeActionEvent)
      Create an instance of this class with nodeActionEvent() initialized to the given value.

      Contains information about an action (operation) called by a node during execution.

      Parameters:
      nodeActionEvent - Contains information about an action (operation) called by a node during execution.

    • fromNodeActionEvent

      public static FlowExecutionEvent fromNodeActionEvent(Consumer<NodeActionEvent.Builder> nodeActionEvent)
      Create an instance of this class with nodeActionEvent() initialized to the given value.

      Contains information about an action (operation) called by a node during execution.

      Parameters:
      nodeActionEvent - Contains information about an action (operation) called by a node during execution.

    • fromNodeDependencyEvent

      public static FlowExecutionEvent fromNodeDependencyEvent(NodeDependencyEvent nodeDependencyEvent)
      Create an instance of this class with nodeDependencyEvent() initialized to the given value.

      Contains information about an internal trace of a specific node during execution.

      Parameters:
      nodeDependencyEvent - Contains information about an internal trace of a specific node during execution.

    • fromNodeDependencyEvent

      public static FlowExecutionEvent fromNodeDependencyEvent(Consumer<NodeDependencyEvent.Builder> nodeDependencyEvent)
      Create an instance of this class with nodeDependencyEvent() initialized to the given value.

      Contains information about an internal trace of a specific node during execution.

      Parameters:
      nodeDependencyEvent - Contains information about an internal trace of 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.