Package software.amazon.awssdk.services.bedrockruntime.model

Class PromptVariableValues

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.PromptVariableValues

All Implemented Interfaces:

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

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

Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see How Prompt management works.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromptVariableValues.Builder
static class	PromptVariableValues.Type

Method Summary

Modifier and Type	Method	Description
static PromptVariableValues.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static PromptVariableValues	fromText(String text)	Create an instance of this class with text() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PromptVariableValues.Builder>	serializableBuilderClass()
String	text()	The text value that the variable maps to.
PromptVariableValues.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PromptVariableValues.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

text

public final String text()

The text value that the variable maps to.

Returns:

The text value that the variable maps to.

toBuilder

public PromptVariableValues.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PromptVariableValues.Builder,PromptVariableValues>

builder

public static PromptVariableValues.Builder builder()

serializableBuilderClass

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

fromText

public static PromptVariableValues fromText(String text)

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

The text value that the variable maps to.

Parameters:

text - The text value that the variable maps to.

type

public PromptVariableValues.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 PromptVariableValues.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 PromptVariableValues.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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo