Class FlowNodeConfiguration

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

Contains configurations for a node in your flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.

See Also:

  • Method Details

    • agent

      public final AgentFlowNodeConfiguration agent()

      Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

      Returns:
      Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

    • collector

      public final CollectorFlowNodeConfiguration collector()

      Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

      Returns:
      Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

    • condition

      public final ConditionFlowNodeConfiguration condition()

      Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.

      Returns:
      Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.

    • inlineCode

      public final InlineCodeFlowNodeConfiguration inlineCode()

      Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.

      Returns:
      Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.

    • input

      public final InputFlowNodeConfiguration input()

      Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

      Returns:
      Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

    • iterator

      public final IteratorFlowNodeConfiguration iterator()

      Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

      The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

      Returns:
      Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

      The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

    • knowledgeBase

      public final KnowledgeBaseFlowNodeConfiguration knowledgeBase()

      Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

      Returns:
      Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

    • lambdaFunction

      public final LambdaFunctionFlowNodeConfiguration lambdaFunction()

      Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

      Returns:
      Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

    • lex

      public final LexFlowNodeConfiguration lex()

      Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

      Returns:
      Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

    • loop

      public final LoopFlowNodeConfiguration loop()

      Contains configurations for a DoWhile loop in your flow.

      Returns:
      Contains configurations for a DoWhile loop in your flow.

    • loopController

      public final LoopControllerFlowNodeConfiguration loopController()

      Contains controller node configurations for a DoWhile loop in your flow.

      Returns:
      Contains controller node configurations for a DoWhile loop in your flow.

    • loopInput

      public final LoopInputFlowNodeConfiguration loopInput()

      Contains input node configurations for a DoWhile loop in your flow.

      Returns:
      Contains input node configurations for a DoWhile loop in your flow.

    • output

      public final OutputFlowNodeConfiguration output()

      Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

      Returns:
      Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

    • prompt

      public final PromptFlowNodeConfiguration prompt()

      Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

      Returns:
      Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

    • retrieval

      public final RetrievalFlowNodeConfiguration retrieval()

      Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

      Returns:
      Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

    • storage

      public final StorageFlowNodeConfiguration storage()

      Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.

      Returns:
      Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.

    • toBuilder

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

    • builder

      public static FlowNodeConfiguration.Builder builder()

    • serializableBuilderClass

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

    • fromAgent

      public static FlowNodeConfiguration fromAgent(AgentFlowNodeConfiguration agent)
      Create an instance of this class with agent() initialized to the given value.

      Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

      Parameters:
      agent - Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

    • fromAgent

      public static FlowNodeConfiguration fromAgent(Consumer<AgentFlowNodeConfiguration.Builder> agent)
      Create an instance of this class with agent() initialized to the given value.

      Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

      Parameters:
      agent - Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.

    • fromCollector

      public static FlowNodeConfiguration fromCollector(CollectorFlowNodeConfiguration collector)
      Create an instance of this class with collector() initialized to the given value.

      Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

      Parameters:
      collector - Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

    • fromCollector

      public static FlowNodeConfiguration fromCollector(Consumer<CollectorFlowNodeConfiguration.Builder> collector)
      Create an instance of this class with collector() initialized to the given value.

      Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

      Parameters:
      collector - Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.

    • fromCondition

      public static FlowNodeConfiguration fromCondition(ConditionFlowNodeConfiguration condition)
      Create an instance of this class with condition() initialized to the given value.

      Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.

      Parameters:
      condition - Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.

    • fromCondition

      public static FlowNodeConfiguration fromCondition(Consumer<ConditionFlowNodeConfiguration.Builder> condition)
      Create an instance of this class with condition() initialized to the given value.

      Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.

      Parameters:
      condition - Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.

    • fromInlineCode

      public static FlowNodeConfiguration fromInlineCode(InlineCodeFlowNodeConfiguration inlineCode)
      Create an instance of this class with inlineCode() initialized to the given value.

      Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.

      Parameters:
      inlineCode - Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.

    • fromInlineCode

      public static FlowNodeConfiguration fromInlineCode(Consumer<InlineCodeFlowNodeConfiguration.Builder> inlineCode)
      Create an instance of this class with inlineCode() initialized to the given value.

      Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.

      Parameters:
      inlineCode - Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.

    • fromInput

      public static FlowNodeConfiguration fromInput(InputFlowNodeConfiguration input)
      Create an instance of this class with input() initialized to the given value.

      Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

      Parameters:
      input - Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

    • fromInput

      public static FlowNodeConfiguration fromInput(Consumer<InputFlowNodeConfiguration.Builder> input)
      Create an instance of this class with input() initialized to the given value.

      Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

      Parameters:
      input - Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.

    • fromIterator

      public static FlowNodeConfiguration fromIterator(IteratorFlowNodeConfiguration iterator)
      Create an instance of this class with iterator() initialized to the given value.

      Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

      The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

      Parameters:
      iterator - Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

      The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

    • fromIterator

      public static FlowNodeConfiguration fromIterator(Consumer<IteratorFlowNodeConfiguration.Builder> iterator)
      Create an instance of this class with iterator() initialized to the given value.

      Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

      The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

      Parameters:
      iterator - Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

      The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

    • fromKnowledgeBase

      public static FlowNodeConfiguration fromKnowledgeBase(KnowledgeBaseFlowNodeConfiguration knowledgeBase)
      Create an instance of this class with knowledgeBase() initialized to the given value.

      Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

      Parameters:
      knowledgeBase - Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

    • fromKnowledgeBase

      public static FlowNodeConfiguration fromKnowledgeBase(Consumer<KnowledgeBaseFlowNodeConfiguration.Builder> knowledgeBase)
      Create an instance of this class with knowledgeBase() initialized to the given value.

      Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

      Parameters:
      knowledgeBase - Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

    • fromLambdaFunction

      public static FlowNodeConfiguration fromLambdaFunction(LambdaFunctionFlowNodeConfiguration lambdaFunction)
      Create an instance of this class with lambdaFunction() initialized to the given value.

      Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

      Parameters:
      lambdaFunction - Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

    • fromLambdaFunction

      public static FlowNodeConfiguration fromLambdaFunction(Consumer<LambdaFunctionFlowNodeConfiguration.Builder> lambdaFunction)
      Create an instance of this class with lambdaFunction() initialized to the given value.

      Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

      Parameters:
      lambdaFunction - Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.

    • fromLex

      public static FlowNodeConfiguration fromLex(LexFlowNodeConfiguration lex)
      Create an instance of this class with lex() initialized to the given value.

      Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

      Parameters:
      lex - Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

    • fromLex

      public static FlowNodeConfiguration fromLex(Consumer<LexFlowNodeConfiguration.Builder> lex)
      Create an instance of this class with lex() initialized to the given value.

      Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

      Parameters:
      lex - Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.

    • fromLoop

      public static FlowNodeConfiguration fromLoop(LoopFlowNodeConfiguration loop)
      Create an instance of this class with loop() initialized to the given value.

      Contains configurations for a DoWhile loop in your flow.

      Parameters:
      loop - Contains configurations for a DoWhile loop in your flow.

    • fromLoop

      public static FlowNodeConfiguration fromLoop(Consumer<LoopFlowNodeConfiguration.Builder> loop)
      Create an instance of this class with loop() initialized to the given value.

      Contains configurations for a DoWhile loop in your flow.

      Parameters:
      loop - Contains configurations for a DoWhile loop in your flow.

    • fromLoopController

      public static FlowNodeConfiguration fromLoopController(LoopControllerFlowNodeConfiguration loopController)
      Create an instance of this class with loopController() initialized to the given value.

      Contains controller node configurations for a DoWhile loop in your flow.

      Parameters:
      loopController - Contains controller node configurations for a DoWhile loop in your flow.

    • fromLoopController

      public static FlowNodeConfiguration fromLoopController(Consumer<LoopControllerFlowNodeConfiguration.Builder> loopController)
      Create an instance of this class with loopController() initialized to the given value.

      Contains controller node configurations for a DoWhile loop in your flow.

      Parameters:
      loopController - Contains controller node configurations for a DoWhile loop in your flow.

    • fromLoopInput

      public static FlowNodeConfiguration fromLoopInput(LoopInputFlowNodeConfiguration loopInput)
      Create an instance of this class with loopInput() initialized to the given value.

      Contains input node configurations for a DoWhile loop in your flow.

      Parameters:
      loopInput - Contains input node configurations for a DoWhile loop in your flow.

    • fromLoopInput

      public static FlowNodeConfiguration fromLoopInput(Consumer<LoopInputFlowNodeConfiguration.Builder> loopInput)
      Create an instance of this class with loopInput() initialized to the given value.

      Contains input node configurations for a DoWhile loop in your flow.

      Parameters:
      loopInput - Contains input node configurations for a DoWhile loop in your flow.

    • fromOutput

      public static FlowNodeConfiguration fromOutput(OutputFlowNodeConfiguration output)
      Create an instance of this class with output() initialized to the given value.

      Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

      Parameters:
      output - Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

    • fromOutput

      public static FlowNodeConfiguration fromOutput(Consumer<OutputFlowNodeConfiguration.Builder> output)
      Create an instance of this class with output() initialized to the given value.

      Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

      Parameters:
      output - Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

    • fromPrompt

      public static FlowNodeConfiguration fromPrompt(PromptFlowNodeConfiguration prompt)
      Create an instance of this class with prompt() initialized to the given value.

      Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

      Parameters:
      prompt - Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

    • fromPrompt

      public static FlowNodeConfiguration fromPrompt(Consumer<PromptFlowNodeConfiguration.Builder> prompt)
      Create an instance of this class with prompt() initialized to the given value.

      Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

      Parameters:
      prompt - Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.

    • fromRetrieval

      public static FlowNodeConfiguration fromRetrieval(RetrievalFlowNodeConfiguration retrieval)
      Create an instance of this class with retrieval() initialized to the given value.

      Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

      Parameters:
      retrieval - Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

    • fromRetrieval

      public static FlowNodeConfiguration fromRetrieval(Consumer<RetrievalFlowNodeConfiguration.Builder> retrieval)
      Create an instance of this class with retrieval() initialized to the given value.

      Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

      Parameters:
      retrieval - Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.

    • fromStorage

      public static FlowNodeConfiguration fromStorage(StorageFlowNodeConfiguration storage)
      Create an instance of this class with storage() initialized to the given value.

      Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.

      Parameters:
      storage - Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.

    • fromStorage

      public static FlowNodeConfiguration fromStorage(Consumer<StorageFlowNodeConfiguration.Builder> storage)
      Create an instance of this class with storage() initialized to the given value.

      Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.

      Parameters:
      storage - Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.

    • type

      public FlowNodeConfiguration.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 FlowNodeConfiguration.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 FlowNodeConfiguration.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.