Interface StartFlowExecutionRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartFlowExecutionRequest

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

Method Summary

Modifier and Type	Method	Description
StartFlowExecutionRequest.Builder	flowAliasIdentifier(String flowAliasIdentifier)	The unique identifier of the flow alias to use for the flow execution.
StartFlowExecutionRequest.Builder	flowExecutionName(String flowExecutionName)	The unique name for the flow execution.
StartFlowExecutionRequest.Builder	flowIdentifier(String flowIdentifier)	The unique identifier of the flow to execute.
StartFlowExecutionRequest.Builder	inputs(Collection<FlowInput> inputs)	The input data required for the flow execution.
StartFlowExecutionRequest.Builder	inputs(Consumer<FlowInput.Builder>... inputs)	The input data required for the flow execution.
StartFlowExecutionRequest.Builder	inputs(FlowInput... inputs)	The input data required for the flow execution.
default StartFlowExecutionRequest.Builder	modelPerformanceConfiguration(Consumer<ModelPerformanceConfiguration.Builder> modelPerformanceConfiguration)	The performance settings for the foundation model used in the flow execution.
StartFlowExecutionRequest.Builder	modelPerformanceConfiguration(ModelPerformanceConfiguration modelPerformanceConfiguration)	The performance settings for the foundation model used in the flow execution.
StartFlowExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartFlowExecutionRequest.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

flowAliasIdentifier

StartFlowExecutionRequest.Builder flowAliasIdentifier(String flowAliasIdentifier)

The unique identifier of the flow alias to use for the flow execution.

Parameters:

flowAliasIdentifier - The unique identifier of the flow alias to use for the flow execution.

Returns:

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

flowExecutionName

StartFlowExecutionRequest.Builder flowExecutionName(String flowExecutionName)

The unique name for the flow execution. If you don't provide one, a system-generated name is used.

Parameters:

flowExecutionName - The unique name for the flow execution. If you don't provide one, a system-generated name is used.

Returns:

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

flowIdentifier

StartFlowExecutionRequest.Builder flowIdentifier(String flowIdentifier)

The unique identifier of the flow to execute.

Parameters:

flowIdentifier - The unique identifier of the flow to execute.

Returns:

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

inputs

StartFlowExecutionRequest.Builder inputs(Collection<FlowInput> inputs)

The input data required for the flow execution. This must match the input schema defined in the flow.

Parameters:

inputs - The input data required for the flow execution. This must match the input schema defined in the flow.

Returns:

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

inputs

StartFlowExecutionRequest.Builder inputs(FlowInput... inputs)

The input data required for the flow execution. This must match the input schema defined in the flow.

Parameters:

inputs - The input data required for the flow execution. This must match the input schema defined in the flow.

Returns:

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

inputs

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

The input data required for the flow execution. This must match the input schema defined in 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

StartFlowExecutionRequest.Builder modelPerformanceConfiguration(ModelPerformanceConfiguration modelPerformanceConfiguration)

The performance settings for the foundation model used in the flow execution.

Parameters:

modelPerformanceConfiguration - The performance settings for the foundation model used in the flow execution.

Returns:

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

modelPerformanceConfiguration

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

The performance settings for the foundation model used in the flow execution.

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

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

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