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 Amazon Bedrock works in the Amazon Bedrock User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFlowNodeConfiguration.Builderstatic classFlowNodeConfiguration.Type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AgentFlowNodeConfigurationagent()Contains configurations for an agent node in your flow.static FlowNodeConfiguration.Builderbuilder()CollectorFlowNodeConfigurationcollector()Contains configurations for a collector node in your flow.ConditionFlowNodeConfigurationcondition()Contains configurations for a Condition node in your flow.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)static FlowNodeConfigurationfromAgent(Consumer<AgentFlowNodeConfiguration.Builder> agent)Create an instance of this class withagent()initialized to the given value.static FlowNodeConfigurationfromAgent(AgentFlowNodeConfiguration agent)Create an instance of this class withagent()initialized to the given value.static FlowNodeConfigurationfromCollector(Consumer<CollectorFlowNodeConfiguration.Builder> collector)Create an instance of this class withcollector()initialized to the given value.static FlowNodeConfigurationfromCollector(CollectorFlowNodeConfiguration collector)Create an instance of this class withcollector()initialized to the given value.static FlowNodeConfigurationfromCondition(Consumer<ConditionFlowNodeConfiguration.Builder> condition)Create an instance of this class withcondition()initialized to the given value.static FlowNodeConfigurationfromCondition(ConditionFlowNodeConfiguration condition)Create an instance of this class withcondition()initialized to the given value.static FlowNodeConfigurationfromInput(Consumer<InputFlowNodeConfiguration.Builder> input)Create an instance of this class withinput()initialized to the given value.static FlowNodeConfigurationfromInput(InputFlowNodeConfiguration input)Create an instance of this class withinput()initialized to the given value.static FlowNodeConfigurationfromIterator(Consumer<IteratorFlowNodeConfiguration.Builder> iterator)Create an instance of this class withiterator()initialized to the given value.static FlowNodeConfigurationfromIterator(IteratorFlowNodeConfiguration iterator)Create an instance of this class withiterator()initialized to the given value.static FlowNodeConfigurationfromKnowledgeBase(Consumer<KnowledgeBaseFlowNodeConfiguration.Builder> knowledgeBase)Create an instance of this class withknowledgeBase()initialized to the given value.static FlowNodeConfigurationfromKnowledgeBase(KnowledgeBaseFlowNodeConfiguration knowledgeBase)Create an instance of this class withknowledgeBase()initialized to the given value.static FlowNodeConfigurationfromLambdaFunction(Consumer<LambdaFunctionFlowNodeConfiguration.Builder> lambdaFunction)Create an instance of this class withlambdaFunction()initialized to the given value.static FlowNodeConfigurationfromLambdaFunction(LambdaFunctionFlowNodeConfiguration lambdaFunction)Create an instance of this class withlambdaFunction()initialized to the given value.static FlowNodeConfigurationfromLex(Consumer<LexFlowNodeConfiguration.Builder> lex)Create an instance of this class withlex()initialized to the given value.static FlowNodeConfigurationfromLex(LexFlowNodeConfiguration lex)Create an instance of this class withlex()initialized to the given value.static FlowNodeConfigurationfromOutput(Consumer<OutputFlowNodeConfiguration.Builder> output)Create an instance of this class withoutput()initialized to the given value.static FlowNodeConfigurationfromOutput(OutputFlowNodeConfiguration output)Create an instance of this class withoutput()initialized to the given value.static FlowNodeConfigurationfromPrompt(Consumer<PromptFlowNodeConfiguration.Builder> prompt)Create an instance of this class withprompt()initialized to the given value.static FlowNodeConfigurationfromPrompt(PromptFlowNodeConfiguration prompt)Create an instance of this class withprompt()initialized to the given value.static FlowNodeConfigurationfromRetrieval(Consumer<RetrievalFlowNodeConfiguration.Builder> retrieval)Create an instance of this class withretrieval()initialized to the given value.static FlowNodeConfigurationfromRetrieval(RetrievalFlowNodeConfiguration retrieval)Create an instance of this class withretrieval()initialized to the given value.static FlowNodeConfigurationfromStorage(Consumer<StorageFlowNodeConfiguration.Builder> storage)Create an instance of this class withstorage()initialized to the given value.static FlowNodeConfigurationfromStorage(StorageFlowNodeConfiguration storage)Create an instance of this class withstorage()initialized to the given value.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InputFlowNodeConfigurationinput()Contains configurations for an input flow node in your flow.IteratorFlowNodeConfigurationiterator()Contains configurations for an iterator node in your flow.KnowledgeBaseFlowNodeConfigurationknowledgeBase()Contains configurations for a knowledge base node in your flow.LambdaFunctionFlowNodeConfigurationlambdaFunction()Contains configurations for a Lambda function node in your flow.LexFlowNodeConfigurationlex()Contains configurations for a Lex node in your flow.OutputFlowNodeConfigurationoutput()Contains configurations for an output flow node in your flow.PromptFlowNodeConfigurationprompt()Contains configurations for a prompt node in your flow.RetrievalFlowNodeConfigurationretrieval()Contains configurations for a Retrieval node in your flow.List<SdkField<?>>sdkFields()static Class<? extends FlowNodeConfiguration.Builder>serializableBuilderClass()StorageFlowNodeConfigurationstorage()Contains configurations for a Storage node in your flow.FlowNodeConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.FlowNodeConfiguration.Typetype()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
-
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.
-
input
public final InputFlowNodeConfiguration input()
Contains configurations for an input flow node in your flow. The first node in the flow.
inputscan't be specified for this node.- Returns:
- Contains configurations for an input flow node in your flow. The first node in the flow.
inputscan'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.
-
output
public final OutputFlowNodeConfiguration output()
Contains configurations for an output flow node in your flow. The last node in the flow.
outputscan't be specified for this node.- Returns:
- Contains configurations for an output flow node in your flow. The last node in the flow.
outputscan'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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FlowNodeConfiguration.Builder,FlowNodeConfiguration>
-
builder
public static FlowNodeConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends FlowNodeConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
fromAgent
public static FlowNodeConfiguration fromAgent(AgentFlowNodeConfiguration agent)
Create an instance of this class withagent()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 withagent()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 withcollector()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 withcollector()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 withcondition()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 withcondition()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.
-
fromInput
public static FlowNodeConfiguration fromInput(InputFlowNodeConfiguration input)
Create an instance of this class withinput()initialized to the given value.Contains configurations for an input flow node in your flow. The first node in the flow.
inputscan't be specified for this node.- Parameters:
input- Contains configurations for an input flow node in your flow. The first node in the flow.inputscan't be specified for this node.
-
fromInput
public static FlowNodeConfiguration fromInput(Consumer<InputFlowNodeConfiguration.Builder> input)
Create an instance of this class withinput()initialized to the given value.Contains configurations for an input flow node in your flow. The first node in the flow.
inputscan't be specified for this node.- Parameters:
input- Contains configurations for an input flow node in your flow. The first node in the flow.inputscan't be specified for this node.
-
fromIterator
public static FlowNodeConfiguration fromIterator(IteratorFlowNodeConfiguration iterator)
Create an instance of this class withiterator()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 withiterator()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 withknowledgeBase()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 withknowledgeBase()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 withlambdaFunction()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 withlambdaFunction()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 withlex()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 withlex()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.
-
fromOutput
public static FlowNodeConfiguration fromOutput(OutputFlowNodeConfiguration output)
Create an instance of this class withoutput()initialized to the given value.Contains configurations for an output flow node in your flow. The last node in the flow.
outputscan't be specified for this node.- Parameters:
output- Contains configurations for an output flow node in your flow. The last node in the flow.outputscan't be specified for this node.
-
fromOutput
public static FlowNodeConfiguration fromOutput(Consumer<OutputFlowNodeConfiguration.Builder> output)
Create an instance of this class withoutput()initialized to the given value.Contains configurations for an output flow node in your flow. The last node in the flow.
outputscan't be specified for this node.- Parameters:
output- Contains configurations for an output flow node in your flow. The last node in the flow.outputscan't be specified for this node.
-
fromPrompt
public static FlowNodeConfiguration fromPrompt(PromptFlowNodeConfiguration prompt)
Create an instance of this class withprompt()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 withprompt()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 withretrieval()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 withretrieval()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 withstorage()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 withstorage()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 beFlowNodeConfiguration.Type.UNKNOWN_TO_SDK_VERSIONif 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 beFlowNodeConfiguration.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set.
-
-