com.amazonaws.services.bedrockagent.model

Class TextPromptTemplateConfiguration

java.lang.Object

com.amazonaws.services.bedrockagent.model.TextPromptTemplateConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TextPromptTemplateConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextPromptTemplateConfiguration()

Method Summary

Modifier and Type	Method and Description
TextPromptTemplateConfiguration	clone()
boolean	equals(Object obj)
List<PromptInputVariable>	getInputVariables() An array of the variables in the prompt template.
String	getText() The message for the prompt.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setInputVariables(Collection<PromptInputVariable> inputVariables) An array of the variables in the prompt template.
void	setText(String text) The message for the prompt.
String	toString() Returns a string representation of this object.
TextPromptTemplateConfiguration	withInputVariables(Collection<PromptInputVariable> inputVariables) An array of the variables in the prompt template.
TextPromptTemplateConfiguration	withInputVariables(PromptInputVariable... inputVariables) An array of the variables in the prompt template.
TextPromptTemplateConfiguration	withText(String text) The message for the prompt.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextPromptTemplateConfiguration

public TextPromptTemplateConfiguration()

Method Detail

getInputVariables

public List<PromptInputVariable> getInputVariables()

An array of the variables in the prompt template.

Returns:

An array of the variables in the prompt template.

setInputVariables

public void setInputVariables(Collection<PromptInputVariable> inputVariables)

An array of the variables in the prompt template.

Parameters:

inputVariables - An array of the variables in the prompt template.

withInputVariables

public TextPromptTemplateConfiguration withInputVariables(PromptInputVariable... inputVariables)

An array of the variables in the prompt template.

NOTE: This method appends the values to the existing list (if any). Use setInputVariables(java.util.Collection) or withInputVariables(java.util.Collection) if you want to override the existing values.

Parameters:

inputVariables - An array of the variables in the prompt template.

Returns:

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

withInputVariables

public TextPromptTemplateConfiguration withInputVariables(Collection<PromptInputVariable> inputVariables)

An array of the variables in the prompt template.

Parameters:

inputVariables - An array of the variables in the prompt template.

Returns:

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

setText

public void setText(String text)

The message for the prompt.

Parameters:

text - The message for the prompt.

getText

public String getText()

The message for the prompt.

Returns:

The message for the prompt.

withText

public TextPromptTemplateConfiguration withText(String text)

The message for the prompt.

Parameters:

text - The message for the prompt.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public TextPromptTemplateConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.