Package software.amazon.awssdk.services.bedrockagent.model

Interface CreatePromptRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreatePromptRequest

public static interface CreatePromptRequest.Builder
extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<CreatePromptRequest.Builder,CreatePromptRequest>

Method Summary

Modifier and Type	Method	Description
CreatePromptRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreatePromptRequest.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
CreatePromptRequest.Builder	defaultVariant(String defaultVariant)	The name of the default variant for the prompt.
CreatePromptRequest.Builder	description(String description)	A description for the prompt.
CreatePromptRequest.Builder	name(String name)	A name for the prompt.
CreatePromptRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreatePromptRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreatePromptRequest.Builder	tags(Map<String,String> tags)	Any tags that you want to attach to the prompt.
CreatePromptRequest.Builder	variants(Collection<PromptVariant> variants)	A list of objects, each containing details about a variant of the prompt.
CreatePromptRequest.Builder	variants(Consumer<PromptVariant.Builder>... variants)	A list of objects, each containing details about a variant of the prompt.
CreatePromptRequest.Builder	variants(PromptVariant... variants)	A list of objects, each containing details about a variant of the prompt.

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

Method Details

clientToken

CreatePromptRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Parameters:

clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

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

customerEncryptionKeyArn

CreatePromptRequest.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

Parameters:

customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

Returns:

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

defaultVariant

CreatePromptRequest.Builder defaultVariant(String defaultVariant)

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

Parameters:

defaultVariant - The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

Returns:

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

description

CreatePromptRequest.Builder description(String description)

A description for the prompt.

Parameters:

description - A description for the prompt.

Returns:

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

name

CreatePromptRequest.Builder name(String name)

A name for the prompt.

Parameters:

name - A name for the prompt.

Returns:

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

tags

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

Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.

Parameters:

tags - Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.

Returns:

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

variants

CreatePromptRequest.Builder variants(Collection<PromptVariant> variants)

A list of objects, each containing details about a variant of the prompt.

Parameters:

variants - A list of objects, each containing details about a variant of the prompt.

Returns:

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

variants

CreatePromptRequest.Builder variants(PromptVariant... variants)

A list of objects, each containing details about a variant of the prompt.

Parameters:

variants - A list of objects, each containing details about a variant of the prompt.

Returns:

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

variants

CreatePromptRequest.Builder variants(Consumer<PromptVariant.Builder>... variants)

A list of objects, each containing details about a variant of the prompt.

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

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

Parameters:

variants - a consumer that will call methods on PromptVariant.Builder

Returns:

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

See Also:

• variants(java.util.Collection<PromptVariant>)

overrideConfiguration

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

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