Interface GetFlowResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockAgentResponse.Builder, Buildable, CopyableBuilder<GetFlowResponse.Builder,GetFlowResponse>, SdkBuilder<GetFlowResponse.Builder,GetFlowResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetFlowResponse

@Mutable
@NotThreadSafe
public static interface GetFlowResponse.Builder
extends BedrockAgentResponse.Builder, SdkPojo, CopyableBuilder<GetFlowResponse.Builder,GetFlowResponse>

Method Summary

Modifier and Type	Method	Description
GetFlowResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the flow.
GetFlowResponse.Builder	createdAt(Instant createdAt)	The time at which the flow was created.
GetFlowResponse.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
default GetFlowResponse.Builder	definition(Consumer<FlowDefinition.Builder> definition)	The definition of the nodes and connections between the nodes in the flow.
GetFlowResponse.Builder	definition(FlowDefinition definition)	The definition of the nodes and connections between the nodes in the flow.
GetFlowResponse.Builder	description(String description)	The description of the flow.
GetFlowResponse.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the service role with permissions to create a flow.
GetFlowResponse.Builder	id(String id)	The unique identifier of the flow.
GetFlowResponse.Builder	name(String name)	The name of the flow.
GetFlowResponse.Builder	status(String status)	The status of the flow.
GetFlowResponse.Builder	status(FlowStatus status)	The status of the flow.
GetFlowResponse.Builder	updatedAt(Instant updatedAt)	The time at which the flow was last updated.
GetFlowResponse.Builder	validations(Collection<FlowValidation> validations)	A list of validation error messages related to the last failed operation on the flow.
GetFlowResponse.Builder	validations(Consumer<FlowValidation.Builder>... validations)	A list of validation error messages related to the last failed operation on the flow.
GetFlowResponse.Builder	validations(FlowValidation... validations)	A list of validation error messages related to the last failed operation on the flow.
GetFlowResponse.Builder	version(String version)	The version of the flow for which information was retrieved.

Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse.Builder

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

name

GetFlowResponse.Builder name(String name)

The name of the flow.

Parameters:

name - The name of the flow.

Returns:

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

description

GetFlowResponse.Builder description(String description)

The description of the flow.

Parameters:

description - The description of the flow.

Returns:

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

executionRoleArn

GetFlowResponse.Builder executionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

Returns:

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

customerEncryptionKeyArn

GetFlowResponse.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

Parameters:

customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

Returns:

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

id

GetFlowResponse.Builder id(String id)

The unique identifier of the flow.

Parameters:

id - The unique identifier of the flow.

Returns:

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

arn

GetFlowResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) of the flow.

Parameters:

arn - The Amazon Resource Name (ARN) of the flow.

Returns:

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

status

GetFlowResponse.Builder status(String status)

The status of the flow. The following statuses are possible:

• NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

• Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

• Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

• Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

Parameters:

status - The status of the flow. The following statuses are possible:

• NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

• Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

• Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

• Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

Returns:

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

See Also:

• FlowStatus
• FlowStatus

status

GetFlowResponse.Builder status(FlowStatus status)

The status of the flow. The following statuses are possible:

• NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

• Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

• Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

• Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

Parameters:

status - The status of the flow. The following statuses are possible:

• NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

• Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

• Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

• Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

Returns:

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

See Also:

• FlowStatus
• FlowStatus

createdAt

GetFlowResponse.Builder createdAt(Instant createdAt)

The time at which the flow was created.

Parameters:

createdAt - The time at which the flow was created.

Returns:

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

updatedAt

GetFlowResponse.Builder updatedAt(Instant updatedAt)

The time at which the flow was last updated.

Parameters:

updatedAt - The time at which the flow was last updated.

Returns:

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

version

GetFlowResponse.Builder version(String version)

The version of the flow for which information was retrieved.

Parameters:

version - The version of the flow for which information was retrieved.

Returns:

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

definition

GetFlowResponse.Builder definition(FlowDefinition definition)

The definition of the nodes and connections between the nodes in the flow.

Parameters:

definition - The definition of the nodes and connections between the nodes in the flow.

Returns:

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

definition

default GetFlowResponse.Builder definition(Consumer<FlowDefinition.Builder> definition)

The definition of the nodes and connections between the nodes in the flow.

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

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

Parameters:

definition - a consumer that will call methods on FlowDefinition.Builder

Returns:

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

See Also:

• definition(FlowDefinition)

validations

GetFlowResponse.Builder validations(Collection<FlowValidation> validations)

A list of validation error messages related to the last failed operation on the flow.

Parameters:

validations - A list of validation error messages related to the last failed operation on the flow.

Returns:

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

validations

GetFlowResponse.Builder validations(FlowValidation... validations)

A list of validation error messages related to the last failed operation on the flow.

Parameters:

validations - A list of validation error messages related to the last failed operation on the flow.

Returns:

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

validations

GetFlowResponse.Builder validations(Consumer<FlowValidation.Builder>... validations)

A list of validation error messages related to the last failed operation on the flow.

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

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

Parameters:

validations - a consumer that will call methods on FlowValidation.Builder

Returns:

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

See Also:

• validations(java.util.Collection<FlowValidation>)