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

Class GuardrailConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailConfiguration

All Implemented Interfaces:

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

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

Configuration information for a guardrail that you use with the Converse operation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static GuardrailConfiguration.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final String	guardrailIdentifier()	The identifier for the guardrail.
final String	guardrailVersion()	The version of the guardrail.
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailConfiguration.Builder>	serializableBuilderClass()
GuardrailConfiguration.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final GuardrailTrace	trace()	The trace behavior for the guardrail.
final String	traceAsString()	The trace behavior for the guardrail.

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 Details

guardrailIdentifier

public final String guardrailIdentifier()

The identifier for the guardrail.

Returns:

The identifier for the guardrail.

guardrailVersion

public final String guardrailVersion()

The version of the guardrail.

Returns:

The version of the guardrail.

trace

public final GuardrailTrace trace()

The trace behavior for the guardrail.

If the service returns an enum value that is not available in the current SDK version, trace will return GuardrailTrace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceAsString().

Returns:

The trace behavior for the guardrail.

See Also:

• GuardrailTrace

traceAsString

public final String traceAsString()

The trace behavior for the guardrail.

If the service returns an enum value that is not available in the current SDK version, trace will return GuardrailTrace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceAsString().

Returns:

The trace behavior for the guardrail.

See Also:

• GuardrailTrace

toBuilder

public GuardrailConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailConfiguration.Builder,GuardrailConfiguration>

builder

public static GuardrailConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo