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

Interface GetPromptResponse.Builder

All Superinterfaces:

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

Enclosing class:

GetPromptResponse

public static interface GetPromptResponse.Builder
extends BedrockAgentResponse.Builder, SdkPojo, CopyableBuilder<GetPromptResponse.Builder,GetPromptResponse>

Method Summary

Modifier and Type	Method	Description
GetPromptResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
GetPromptResponse.Builder	createdAt(Instant createdAt)	The time at which the prompt was created.
GetPromptResponse.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
GetPromptResponse.Builder	defaultVariant(String defaultVariant)	The name of the default variant for the prompt.
GetPromptResponse.Builder	description(String description)	The descriptino of the prompt.
GetPromptResponse.Builder	id(String id)	The unique identifier of the prompt.
GetPromptResponse.Builder	name(String name)	The name of the prompt.
GetPromptResponse.Builder	updatedAt(Instant updatedAt)	The time at which the prompt was last updated.
GetPromptResponse.Builder	variants(Collection<PromptVariant> variants)	A list of objects, each containing details about a variant of the prompt.
GetPromptResponse.Builder	variants(Consumer<PromptVariant.Builder>... variants)	A list of objects, each containing details about a variant of the prompt.
GetPromptResponse.Builder	variants(PromptVariant... variants)	A list of objects, each containing details about a variant of the prompt.
GetPromptResponse.Builder	version(String version)	The version of the prompt.

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

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

sdkHttpResponse, sdkHttpResponse

Method Detail

arn

GetPromptResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

Parameters:

arn - The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

Returns:

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

createdAt

GetPromptResponse.Builder createdAt(Instant createdAt)

The time at which the prompt was created.

Parameters:

createdAt - The time at which the prompt was created.

Returns:

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

customerEncryptionKeyArn

GetPromptResponse.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

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

Parameters:

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

Returns:

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

defaultVariant

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

GetPromptResponse.Builder description(String description)

The descriptino of the prompt.

Parameters:

description - The descriptino of the prompt.

Returns:

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

id

GetPromptResponse.Builder id(String id)

The unique identifier of the prompt.

Parameters:

id - The unique identifier of the prompt.

Returns:

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

name

GetPromptResponse.Builder name(String name)

The name of the prompt.

Parameters:

name - The name of the prompt.

Returns:

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

updatedAt

GetPromptResponse.Builder updatedAt(Instant updatedAt)

The time at which the prompt was last updated.

Parameters:

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

Returns:

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

variants

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

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

GetPromptResponse.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).

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)

version

GetPromptResponse.Builder version(String version)

The version of the prompt.

Parameters:

version - The version of the prompt.

Returns:

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