Enum RetrievalInstructionFieldName

java.lang.Object

java.lang.Enum<RetrievalInstructionFieldName>

software.amazon.awssdk.services.bedrockagent.model.RetrievalInstructionFieldName

All Implemented Interfaces:

Serializable, Comparable<RetrievalInstructionFieldName>

@Generated("software.amazon.awssdk:codegen")
public enum RetrievalInstructionFieldName
extends Enum<RetrievalInstructionFieldName>

Identifies one field of RetrievalInstructionContent:

• RETRIEVAL_GUIDANCE – retrievalGuidance

• PERSONA – persona

• ANSWER_FORMAT – answerFormat

• ANSWER_POLICY – answerPolicy

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANSWER_FORMAT
ANSWER_POLICY
PERSONA
RETRIEVAL_GUIDANCE
UNKNOWN_TO_SDK_VERSION

Method Summary

Modifier and Type	Method	Description
static RetrievalInstructionFieldName	fromValue(String value)	Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<RetrievalInstructionFieldName>	knownValues()	Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static RetrievalInstructionFieldName	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RetrievalInstructionFieldName[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RETRIEVAL_GUIDANCE

public static final RetrievalInstructionFieldName RETRIEVAL_GUIDANCE

PERSONA

public static final RetrievalInstructionFieldName PERSONA

ANSWER_FORMAT

public static final RetrievalInstructionFieldName ANSWER_FORMAT

ANSWER_POLICY

public static final RetrievalInstructionFieldName ANSWER_POLICY

UNKNOWN_TO_SDK_VERSION

public static final RetrievalInstructionFieldName UNKNOWN_TO_SDK_VERSION

Method Details

values

public static RetrievalInstructionFieldName[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RetrievalInstructionFieldName valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<RetrievalInstructionFieldName>

fromValue

public static RetrievalInstructionFieldName fromValue(String value)

Use this in place of valueOf to convert the raw string returned by the service into the enum value.

Parameters:

value - real value

Returns:

RetrievalInstructionFieldName corresponding to the value

knownValues

public static Set<RetrievalInstructionFieldName> knownValues()

Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.

Returns:

a Set of known RetrievalInstructionFieldNames