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

Class GuardrailTopic

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailTopic

All Implemented Interfaces:

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

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

Information about a topic guardrail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailTopic.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailTopicPolicyAction	action()	The action the guardrail should take when it intervenes on a topic.
String	actionAsString()	The action the guardrail should take when it intervenes on a topic.
static GuardrailTopic.Builder	builder()
Boolean	detected()	Indicates whether topic content that breaches the guardrail configuration is detected.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name for the guardrail.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailTopic.Builder>	serializableBuilderClass()
GuardrailTopic.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailTopicType	type()	The type behavior that the guardrail should perform when the model detects the topic.
String	typeAsString()	The type behavior that the guardrail should perform when the model detects the topic.

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

name

public final String name()

The name for the guardrail.

Returns:

The name for the guardrail.

type

public final GuardrailTopicType type()

The type behavior that the guardrail should perform when the model detects the topic.

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

Returns:

The type behavior that the guardrail should perform when the model detects the topic.

See Also:

GuardrailTopicType

typeAsString

public final String typeAsString()

The type behavior that the guardrail should perform when the model detects the topic.

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

Returns:

The type behavior that the guardrail should perform when the model detects the topic.

See Also:

GuardrailTopicType

action

public final GuardrailTopicPolicyAction action()

The action the guardrail should take when it intervenes on a topic.

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

Returns:

The action the guardrail should take when it intervenes on a topic.

See Also:

GuardrailTopicPolicyAction

actionAsString

public final String actionAsString()

The action the guardrail should take when it intervenes on a topic.

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

Returns:

The action the guardrail should take when it intervenes on a topic.

See Also:

GuardrailTopicPolicyAction

detected

public final Boolean detected()

Indicates whether topic content that breaches the guardrail configuration is detected.

Returns:

Indicates whether topic content that breaches the guardrail configuration is detected.

toBuilder

public GuardrailTopic.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailTopic.Builder,GuardrailTopic>

builder

public static GuardrailTopic.Builder builder()

serializableBuilderClass

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