Class LoopFlowNodeConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.LoopFlowNodeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LoopFlowNodeConfiguration.Builder,LoopFlowNodeConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class LoopFlowNodeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoopFlowNodeConfiguration.Builder,LoopFlowNodeConfiguration>

Contains configurations for the nodes of a DoWhile loop in your flow.

A DoWhile loop is made up of the following nodes:

  • Loop - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.

  • LoopInput - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.

  • Body nodes - The processing nodes that execute within each loop iteration. These can be nodes for handling data in your flow, such as a prompt or Lambda function nodes. Some node types aren't supported inside a DoWhile loop body. For more information, see LoopIncompatibleNodeTypeFlowValidationDetails.

  • LoopController - The node that evaluates whether the loop should continue or exit based on a condition.

These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.

See Also:

  • Method Details

    • definition

      public final FlowDefinition definition()

      The definition of the DoWhile loop nodes and connections between nodes in the flow.

      Returns:
      The definition of the DoWhile loop nodes and connections between nodes in the flow.

    • toBuilder

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

    • builder

      public static LoopFlowNodeConfiguration.Builder builder()

    • serializableBuilderClass

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

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