Interface CreateRetrievalInstructionRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateRetrievalInstructionRequest

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

Method Summary

Modifier and Type	Method	Description
CreateRetrievalInstructionRequest.Builder	clientToken(String clientToken)	A caller-supplied token that makes a retried create return the existing resource rather than a second one.
CreateRetrievalInstructionRequest.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest.
CreateRetrievalInstructionRequest.Builder	description(String description)	Specifies a description of the retrieval instruction.
default CreateRetrievalInstructionRequest.Builder	instruction(Consumer<RetrievalInstructionContent.Builder> instruction)	The instruction content, as a set of named fields.
CreateRetrievalInstructionRequest.Builder	instruction(RetrievalInstructionContent instruction)	The instruction content, as a set of named fields.
CreateRetrievalInstructionRequest.Builder	name(String name)	Specifies the name of the retrieval instruction.
CreateRetrievalInstructionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateRetrievalInstructionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateRetrievalInstructionRequest.Builder	tags(Map<String,String> tags)	Tags for the retrieval instruction.

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

clientToken

CreateRetrievalInstructionRequest.Builder clientToken(String clientToken)

A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.

Parameters:

clientToken - A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.

Returns:

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

name

CreateRetrievalInstructionRequest.Builder name(String name)

Specifies the name of the retrieval instruction.

Parameters:

name - Specifies the name of the retrieval instruction.

Returns:

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

instruction

CreateRetrievalInstructionRequest.Builder instruction(RetrievalInstructionContent instruction)

The instruction content, as a set of named fields. Get does not return this field until the create review passes.

Parameters:

instruction - The instruction content, as a set of named fields. Get does not return this field until the create review passes.

Returns:

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

instruction

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

The instruction content, as a set of named fields. Get does not return this field until the create 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

CreateRetrievalInstructionRequest.Builder description(String description)

Specifies a description of the retrieval instruction.

Parameters:

description - Specifies a description of the retrieval instruction.

Returns:

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

customerEncryptionKeyArn

CreateRetrievalInstructionRequest.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.

Parameters:

customerEncryptionKeyArn - The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.

Returns:

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

tags

CreateRetrievalInstructionRequest.Builder tags(Map<String,String> tags)

Tags for the retrieval instruction.

Parameters:

tags - Tags for the retrieval instruction.

Returns:

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

overrideConfiguration

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

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