Class PromptTemplateConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.PromptTemplateConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PromptTemplateConfiguration.Builder,PromptTemplateConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class PromptTemplateConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PromptTemplateConfiguration.Builder,PromptTemplateConfiguration>

Contains the message for a prompt. For more information, see Construct and store reusable prompts with Prompt management in Amazon Bedrock.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromptTemplateConfiguration.Builder
static enum	PromptTemplateConfiguration.Type

Method Summary

Modifier and Type	Method	Description
static PromptTemplateConfiguration.Builder	builder()
final ChatPromptTemplateConfiguration	chat()	Contains configurations to use the prompt in a conversational format.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
static PromptTemplateConfiguration	fromChat(Consumer<ChatPromptTemplateConfiguration.Builder> chat)	Create an instance of this class with chat() initialized to the given value.
static PromptTemplateConfiguration	fromChat(ChatPromptTemplateConfiguration chat)	Create an instance of this class with chat() initialized to the given value.
static PromptTemplateConfiguration	fromText(Consumer<TextPromptTemplateConfiguration.Builder> text)	Create an instance of this class with text() initialized to the given value.
static PromptTemplateConfiguration	fromText(TextPromptTemplateConfiguration text)	Create an instance of this class with text() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends PromptTemplateConfiguration.Builder>	serializableBuilderClass()
final TextPromptTemplateConfiguration	text()	Contains configurations for the text in a message for a prompt.
PromptTemplateConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
PromptTemplateConfiguration.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

chat

public final ChatPromptTemplateConfiguration chat()

Contains configurations to use the prompt in a conversational format.

Returns:

Contains configurations to use the prompt in a conversational format.

text

public final TextPromptTemplateConfiguration text()

Contains configurations for the text in a message for a prompt.

Returns:

Contains configurations for the text in a message for a prompt.

toBuilder

public PromptTemplateConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PromptTemplateConfiguration.Builder,PromptTemplateConfiguration>

Returns:

a builder for type T

builder

public static PromptTemplateConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PromptTemplateConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

fromChat

public static PromptTemplateConfiguration fromChat(ChatPromptTemplateConfiguration chat)

Create an instance of this class with chat() initialized to the given value.

Contains configurations to use the prompt in a conversational format.

Parameters:

chat - Contains configurations to use the prompt in a conversational format.

fromChat

public static PromptTemplateConfiguration fromChat(Consumer<ChatPromptTemplateConfiguration.Builder> chat)

Create an instance of this class with chat() initialized to the given value.

Contains configurations to use the prompt in a conversational format.

Parameters:

chat - Contains configurations to use the prompt in a conversational format.

fromText

public static PromptTemplateConfiguration fromText(TextPromptTemplateConfiguration text)

Create an instance of this class with text() initialized to the given value.

Contains configurations for the text in a message for a prompt.

Parameters:

text - Contains configurations for the text in a message for a prompt.

fromText

public static PromptTemplateConfiguration fromText(Consumer<TextPromptTemplateConfiguration.Builder> text)

Create an instance of this class with text() initialized to the given value.

Contains configurations for the text in a message for a prompt.

Parameters:

text - Contains configurations for the text in a message for a prompt.

type

public PromptTemplateConfiguration.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be PromptTemplateConfiguration.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be PromptTemplateConfiguration.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.