Interface InvokeFlowRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRuntimeRequest.Builder, Buildable, CopyableBuilder<InvokeFlowRequest.Builder,InvokeFlowRequest>, SdkBuilder<InvokeFlowRequest.Builder,InvokeFlowRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

InvokeFlowRequest

@Mutable
@NotThreadSafe
public static interface InvokeFlowRequest.Builder
extends BedrockAgentRuntimeRequest.Builder, SdkPojo, CopyableBuilder<InvokeFlowRequest.Builder,InvokeFlowRequest>

Method Summary

Modifier and Type	Method	Description
InvokeFlowRequest.Builder	enableTrace(Boolean enableTrace)	Specifies whether to return the trace for the flow or not.
InvokeFlowRequest.Builder	executionId(String executionId)	The unique identifier for the current flow execution.
InvokeFlowRequest.Builder	flowAliasIdentifier(String flowAliasIdentifier)	The unique identifier of the flow alias.
InvokeFlowRequest.Builder	flowIdentifier(String flowIdentifier)	The unique identifier of the flow.
InvokeFlowRequest.Builder	inputs(Collection<FlowInput> inputs)	A list of objects, each containing information about an input into the flow.
InvokeFlowRequest.Builder	inputs(Consumer<FlowInput.Builder>... inputs)	A list of objects, each containing information about an input into the flow.
InvokeFlowRequest.Builder	inputs(FlowInput... inputs)	A list of objects, each containing information about an input into the flow.
default InvokeFlowRequest.Builder	modelPerformanceConfiguration(Consumer<ModelPerformanceConfiguration.Builder> modelPerformanceConfiguration)	Model performance settings for the request.
InvokeFlowRequest.Builder	modelPerformanceConfiguration(ModelPerformanceConfiguration modelPerformanceConfiguration)	Model performance settings for the request.
InvokeFlowRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
InvokeFlowRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest.Builder

build

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, sdkFieldNameToField, sdkFields

Method Details

enableTrace

InvokeFlowRequest.Builder enableTrace(Boolean enableTrace)

Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

Parameters:

enableTrace - Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

Returns:

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

executionId

InvokeFlowRequest.Builder executionId(String executionId)

The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.

Parameters:

executionId - The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.

Returns:

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

flowAliasIdentifier

InvokeFlowRequest.Builder flowAliasIdentifier(String flowAliasIdentifier)

The unique identifier of the flow alias.

Parameters:

flowAliasIdentifier - The unique identifier of the flow alias.

Returns:

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

flowIdentifier

InvokeFlowRequest.Builder flowIdentifier(String flowIdentifier)

The unique identifier of the flow.

Parameters:

flowIdentifier - The unique identifier of the flow.

Returns:

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

inputs

InvokeFlowRequest.Builder inputs(Collection<FlowInput> inputs)

A list of objects, each containing information about an input into the flow.

Parameters:

inputs - A list of objects, each containing information about an input into the flow.

Returns:

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

inputs

InvokeFlowRequest.Builder inputs(FlowInput... inputs)

A list of objects, each containing information about an input into the flow.

Parameters:

inputs - A list of objects, each containing information about an input into the flow.

Returns:

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

inputs

InvokeFlowRequest.Builder inputs(Consumer<FlowInput.Builder>... inputs)

A list of objects, each containing information about an input into the flow.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputs(List<FlowInput>).

Parameters:

inputs - a consumer that will call methods on FlowInput.Builder

Returns:

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

See Also:

• inputs(java.util.Collection<FlowInput>)

modelPerformanceConfiguration

InvokeFlowRequest.Builder modelPerformanceConfiguration(ModelPerformanceConfiguration modelPerformanceConfiguration)

Model performance settings for the request.

Parameters:

modelPerformanceConfiguration - Model performance settings for the request.

Returns:

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

modelPerformanceConfiguration

default InvokeFlowRequest.Builder modelPerformanceConfiguration(Consumer<ModelPerformanceConfiguration.Builder> modelPerformanceConfiguration)

Model performance settings for the request.

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

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

Parameters:

modelPerformanceConfiguration - a consumer that will call methods on ModelPerformanceConfiguration.Builder

Returns:

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

See Also:

• modelPerformanceConfiguration(ModelPerformanceConfiguration)

overrideConfiguration

InvokeFlowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

InvokeFlowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.