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

Class TextPromptTemplateConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.TextPromptTemplateConfiguration

All Implemented Interfaces:

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

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

Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextPromptTemplateConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static TextPromptTemplateConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputVariables()	For responses, this returns true if the service returned a value for the InputVariables property.
List<PromptInputVariable>	inputVariables()	An array of the variables in the prompt template.
List<SdkField<?>>	sdkFields()
static Class<? extends TextPromptTemplateConfiguration.Builder>	serializableBuilderClass()
String	text()	The message for the prompt.
TextPromptTemplateConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasInputVariables

public final boolean hasInputVariables()

For responses, this returns true if the service returned a value for the InputVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

inputVariables

public final List<PromptInputVariable> inputVariables()

An array of the variables in the prompt template.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInputVariables() method.

Returns:

An array of the variables in the prompt template.

text

public final String text()

The message for the prompt.

Returns:

The message for the prompt.

toBuilder

public TextPromptTemplateConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TextPromptTemplateConfiguration.Builder,TextPromptTemplateConfiguration>

builder

public static TextPromptTemplateConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends TextPromptTemplateConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo