Package software.amazon.awssdk.services.bedrockagent.model

Interface FlowNodeConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FlowNodeConfiguration.Builder,FlowNodeConfiguration>, SdkBuilder<FlowNodeConfiguration.Builder,FlowNodeConfiguration>, SdkPojo

Enclosing class:

FlowNodeConfiguration

public static interface FlowNodeConfiguration.Builder
extends SdkPojo, CopyableBuilder<FlowNodeConfiguration.Builder,FlowNodeConfiguration>

Method Summary

Modifier and Type	Method	Description
default FlowNodeConfiguration.Builder	agent(Consumer<AgentFlowNodeConfiguration.Builder> agent)	Contains configurations for an agent node in your flow.
FlowNodeConfiguration.Builder	agent(AgentFlowNodeConfiguration agent)	Contains configurations for an agent node in your flow.
default FlowNodeConfiguration.Builder	collector(Consumer<CollectorFlowNodeConfiguration.Builder> collector)	Contains configurations for a collector node in your flow.
FlowNodeConfiguration.Builder	collector(CollectorFlowNodeConfiguration collector)	Contains configurations for a collector node in your flow.
default FlowNodeConfiguration.Builder	condition(Consumer<ConditionFlowNodeConfiguration.Builder> condition)	Contains configurations for a Condition node in your flow.
FlowNodeConfiguration.Builder	condition(ConditionFlowNodeConfiguration condition)	Contains configurations for a Condition node in your flow.
default FlowNodeConfiguration.Builder	input(Consumer<InputFlowNodeConfiguration.Builder> input)	Contains configurations for an input flow node in your flow.
FlowNodeConfiguration.Builder	input(InputFlowNodeConfiguration input)	Contains configurations for an input flow node in your flow.
default FlowNodeConfiguration.Builder	iterator(Consumer<IteratorFlowNodeConfiguration.Builder> iterator)	Contains configurations for an iterator node in your flow.
FlowNodeConfiguration.Builder	iterator(IteratorFlowNodeConfiguration iterator)	Contains configurations for an iterator node in your flow.
default FlowNodeConfiguration.Builder	knowledgeBase(Consumer<KnowledgeBaseFlowNodeConfiguration.Builder> knowledgeBase)	Contains configurations for a knowledge base node in your flow.
FlowNodeConfiguration.Builder	knowledgeBase(KnowledgeBaseFlowNodeConfiguration knowledgeBase)	Contains configurations for a knowledge base node in your flow.
default FlowNodeConfiguration.Builder	lambdaFunction(Consumer<LambdaFunctionFlowNodeConfiguration.Builder> lambdaFunction)	Contains configurations for a Lambda function node in your flow.
FlowNodeConfiguration.Builder	lambdaFunction(LambdaFunctionFlowNodeConfiguration lambdaFunction)	Contains configurations for a Lambda function node in your flow.
default FlowNodeConfiguration.Builder	lex(Consumer<LexFlowNodeConfiguration.Builder> lex)	Contains configurations for a Lex node in your flow.
FlowNodeConfiguration.Builder	lex(LexFlowNodeConfiguration lex)	Contains configurations for a Lex node in your flow.
default FlowNodeConfiguration.Builder	output(Consumer<OutputFlowNodeConfiguration.Builder> output)	Contains configurations for an output flow node in your flow.
FlowNodeConfiguration.Builder	output(OutputFlowNodeConfiguration output)	Contains configurations for an output flow node in your flow.
default FlowNodeConfiguration.Builder	prompt(Consumer<PromptFlowNodeConfiguration.Builder> prompt)	Contains configurations for a prompt node in your flow.
FlowNodeConfiguration.Builder	prompt(PromptFlowNodeConfiguration prompt)	Contains configurations for a prompt node in your flow.
default FlowNodeConfiguration.Builder	retrieval(Consumer<RetrievalFlowNodeConfiguration.Builder> retrieval)	Contains configurations for a Retrieval node in your flow.
FlowNodeConfiguration.Builder	retrieval(RetrievalFlowNodeConfiguration retrieval)	Contains configurations for a Retrieval node in your flow.
default FlowNodeConfiguration.Builder	storage(Consumer<StorageFlowNodeConfiguration.Builder> storage)	Contains configurations for a Storage node in your flow.
FlowNodeConfiguration.Builder	storage(StorageFlowNodeConfiguration storage)	Contains configurations for a Storage node in your flow.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

agent

FlowNodeConfiguration.Builder agent(AgentFlowNodeConfiguration agent)

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

agent

default FlowNodeConfiguration.Builder agent(Consumer<AgentFlowNodeConfiguration.Builder> agent)

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

This is a convenience method that creates an instance of the AgentFlowNodeConfiguration.Builder avoiding the need to create one manually via AgentFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to agent(AgentFlowNodeConfiguration).

Parameters:

agent - a consumer that will call methods on AgentFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• agent(AgentFlowNodeConfiguration)

collector

FlowNodeConfiguration.Builder collector(CollectorFlowNodeConfiguration collector)

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

collector

default FlowNodeConfiguration.Builder collector(Consumer<CollectorFlowNodeConfiguration.Builder> collector)

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

This is a convenience method that creates an instance of the CollectorFlowNodeConfiguration.Builder avoiding the need to create one manually via CollectorFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to collector(CollectorFlowNodeConfiguration).

Parameters:

collector - a consumer that will call methods on CollectorFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• collector(CollectorFlowNodeConfiguration)

condition

FlowNodeConfiguration.Builder condition(ConditionFlowNodeConfiguration condition)

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

condition

default FlowNodeConfiguration.Builder condition(Consumer<ConditionFlowNodeConfiguration.Builder> condition)

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

This is a convenience method that creates an instance of the ConditionFlowNodeConfiguration.Builder avoiding the need to create one manually via ConditionFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to condition(ConditionFlowNodeConfiguration).

Parameters:

condition - a consumer that will call methods on ConditionFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• condition(ConditionFlowNodeConfiguration)

input

FlowNodeConfiguration.Builder input(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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

input

default FlowNodeConfiguration.Builder input(Consumer<InputFlowNodeConfiguration.Builder> 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.

This is a convenience method that creates an instance of the InputFlowNodeConfiguration.Builder avoiding the need to create one manually via InputFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to input(InputFlowNodeConfiguration).

Parameters:

input - a consumer that will call methods on InputFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• input(InputFlowNodeConfiguration)

iterator

FlowNodeConfiguration.Builder iterator(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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

iterator

default FlowNodeConfiguration.Builder iterator(Consumer<IteratorFlowNodeConfiguration.Builder> 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.

This is a convenience method that creates an instance of the IteratorFlowNodeConfiguration.Builder avoiding the need to create one manually via IteratorFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to iterator(IteratorFlowNodeConfiguration).

Parameters:

iterator - a consumer that will call methods on IteratorFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• iterator(IteratorFlowNodeConfiguration)

knowledgeBase

FlowNodeConfiguration.Builder knowledgeBase(KnowledgeBaseFlowNodeConfiguration knowledgeBase)

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

knowledgeBase

default FlowNodeConfiguration.Builder knowledgeBase(Consumer<KnowledgeBaseFlowNodeConfiguration.Builder> knowledgeBase)

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

This is a convenience method that creates an instance of the KnowledgeBaseFlowNodeConfiguration.Builder avoiding the need to create one manually via KnowledgeBaseFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to knowledgeBase(KnowledgeBaseFlowNodeConfiguration).

Parameters:

knowledgeBase - a consumer that will call methods on KnowledgeBaseFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• knowledgeBase(KnowledgeBaseFlowNodeConfiguration)

lambdaFunction

FlowNodeConfiguration.Builder lambdaFunction(LambdaFunctionFlowNodeConfiguration lambdaFunction)

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaFunction

default FlowNodeConfiguration.Builder lambdaFunction(Consumer<LambdaFunctionFlowNodeConfiguration.Builder> lambdaFunction)

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

This is a convenience method that creates an instance of the LambdaFunctionFlowNodeConfiguration.Builder avoiding the need to create one manually via LambdaFunctionFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lambdaFunction(LambdaFunctionFlowNodeConfiguration).

Parameters:

lambdaFunction - a consumer that will call methods on LambdaFunctionFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• lambdaFunction(LambdaFunctionFlowNodeConfiguration)

lex

FlowNodeConfiguration.Builder lex(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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lex

default FlowNodeConfiguration.Builder lex(Consumer<LexFlowNodeConfiguration.Builder> 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.

This is a convenience method that creates an instance of the LexFlowNodeConfiguration.Builder avoiding the need to create one manually via LexFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lex(LexFlowNodeConfiguration).

Parameters:

lex - a consumer that will call methods on LexFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• lex(LexFlowNodeConfiguration)

output

FlowNodeConfiguration.Builder output(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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

output

default FlowNodeConfiguration.Builder output(Consumer<OutputFlowNodeConfiguration.Builder> 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.

This is a convenience method that creates an instance of the OutputFlowNodeConfiguration.Builder avoiding the need to create one manually via OutputFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to output(OutputFlowNodeConfiguration).

Parameters:

output - a consumer that will call methods on OutputFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• output(OutputFlowNodeConfiguration)

prompt

FlowNodeConfiguration.Builder prompt(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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

prompt

default FlowNodeConfiguration.Builder prompt(Consumer<PromptFlowNodeConfiguration.Builder> 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.

This is a convenience method that creates an instance of the PromptFlowNodeConfiguration.Builder avoiding the need to create one manually via PromptFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to prompt(PromptFlowNodeConfiguration).

Parameters:

prompt - a consumer that will call methods on PromptFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• prompt(PromptFlowNodeConfiguration)

retrieval

FlowNodeConfiguration.Builder retrieval(RetrievalFlowNodeConfiguration retrieval)

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

retrieval

default FlowNodeConfiguration.Builder retrieval(Consumer<RetrievalFlowNodeConfiguration.Builder> retrieval)

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

This is a convenience method that creates an instance of the RetrievalFlowNodeConfiguration.Builder avoiding the need to create one manually via RetrievalFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retrieval(RetrievalFlowNodeConfiguration).

Parameters:

retrieval - a consumer that will call methods on RetrievalFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• retrieval(RetrievalFlowNodeConfiguration)

storage

FlowNodeConfiguration.Builder storage(StorageFlowNodeConfiguration storage)

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

storage

default FlowNodeConfiguration.Builder storage(Consumer<StorageFlowNodeConfiguration.Builder> storage)

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

This is a convenience method that creates an instance of the StorageFlowNodeConfiguration.Builder avoiding the need to create one manually via StorageFlowNodeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storage(StorageFlowNodeConfiguration).

Parameters:

storage - a consumer that will call methods on StorageFlowNodeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• storage(StorageFlowNodeConfiguration)