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.

See Also:

  • Method Details

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

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

    • toBuilder

      public FlowOutputEvent.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<FlowOutputEvent.Builder,FlowOutputEvent>
      Returns:
      a builder for type T

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

    • copy

      public final FlowOutputEvent copy(Consumer<? super FlowOutputEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<FlowOutputEvent.Builder,FlowOutputEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

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

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