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

Enum StopReason

java.lang.Object

java.lang.Enum<StopReason>

software.amazon.awssdk.services.bedrockruntime.model.StopReason

All Implemented Interfaces:

Serializable, Comparable<StopReason>

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTENT_FILTERED
END_TURN
GUARDRAIL_INTERVENED
MAX_TOKENS
STOP_SEQUENCE
TOOL_USE
UNKNOWN_TO_SDK_VERSION

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

END_TURN

public static final StopReason END_TURN

TOOL_USE

public static final StopReason TOOL_USE

MAX_TOKENS

public static final StopReason MAX_TOKENS

STOP_SEQUENCE

public static final StopReason STOP_SEQUENCE

GUARDRAIL_INTERVENED

public static final StopReason GUARDRAIL_INTERVENED

CONTENT_FILTERED

public static final StopReason CONTENT_FILTERED

UNKNOWN_TO_SDK_VERSION

public static final StopReason UNKNOWN_TO_SDK_VERSION

Method Detail

values

public static StopReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StopReason c : StopReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static StopReason 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<StopReason>

fromValue

public static StopReason 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:

StopReason corresponding to the value

knownValues

public static Set<StopReason> 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 StopReasons