Interface UpdateRetrievalInstructionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRequest.Builder, Buildable, CopyableBuilder<UpdateRetrievalInstructionRequest.Builder,UpdateRetrievalInstructionRequest>, SdkBuilder<UpdateRetrievalInstructionRequest.Builder,UpdateRetrievalInstructionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateRetrievalInstructionRequest

@Mutable
@NotThreadSafe
public static interface UpdateRetrievalInstructionRequest.Builder
extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<UpdateRetrievalInstructionRequest.Builder,UpdateRetrievalInstructionRequest>

Method Summary

Modifier and Type	Method	Description
UpdateRetrievalInstructionRequest.Builder	description(String description)	A replacement description; applied together with the content when the review passes.
default UpdateRetrievalInstructionRequest.Builder	instruction(Consumer<RetrievalInstructionContent.Builder> instruction)	The replacement instruction content.
UpdateRetrievalInstructionRequest.Builder	instruction(RetrievalInstructionContent instruction)	The replacement instruction content.
UpdateRetrievalInstructionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateRetrievalInstructionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateRetrievalInstructionRequest.Builder	retrievalInstructionId(String retrievalInstructionId)	The identifier of the retrieval instruction to update.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.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

retrievalInstructionId

UpdateRetrievalInstructionRequest.Builder retrievalInstructionId(String retrievalInstructionId)

The identifier of the retrieval instruction to update.

Parameters:

retrievalInstructionId - The identifier of the retrieval instruction to update.

Returns:

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

instruction

UpdateRetrievalInstructionRequest.Builder instruction(RetrievalInstructionContent instruction)

The replacement instruction content. This is a full replacement of all four fields, not a patch. During UPDATING, Get continues to return the previously-served content until the update review passes.

Parameters:

instruction - The replacement instruction content. This is a full replacement of all four fields, not a patch. During UPDATING, Get continues to return the previously-served content until the update review passes.

Returns:

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

instruction

default UpdateRetrievalInstructionRequest.Builder instruction(Consumer<RetrievalInstructionContent.Builder> instruction)

The replacement instruction content. This is a full replacement of all four fields, not a patch. During UPDATING, Get continues to return the previously-served content until the update review passes.

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

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

Parameters:

instruction - a consumer that will call methods on RetrievalInstructionContent.Builder

Returns:

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

See Also:

• instruction(RetrievalInstructionContent)

description

UpdateRetrievalInstructionRequest.Builder description(String description)

A replacement description; applied together with the content when the review passes. Omit to clear.

Parameters:

description - A replacement description; applied together with the content when the review passes. Omit to clear.

Returns:

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

overrideConfiguration

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

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