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

Class GuardrailCustomWord

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailCustomWord

All Implemented Interfaces:

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

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

A custom word configured in a guardrail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailCustomWord.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailWordPolicyAction	action()	The action for the custom word.
String	actionAsString()	The action for the custom word.
static GuardrailCustomWord.Builder	builder()
Boolean	detected()	Indicates whether custom word 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	match()	The match for the custom word.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailCustomWord.Builder>	serializableBuilderClass()
GuardrailCustomWord.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

match

public final String match()

The match for the custom word.

Returns:

The match for the custom word.

action

public final GuardrailWordPolicyAction action()

The action for the custom word.

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

Returns:

The action for the custom word.

See Also:

GuardrailWordPolicyAction

actionAsString

public final String actionAsString()

The action for the custom word.

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

Returns:

The action for the custom word.

See Also:

GuardrailWordPolicyAction

detected

public final Boolean detected()

Indicates whether custom word content that breaches the guardrail configuration is detected.

Returns:

Indicates whether custom word content that breaches the guardrail configuration is detected.

toBuilder

public GuardrailCustomWord.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailCustomWord.Builder,GuardrailCustomWord>

builder

public static GuardrailCustomWord.Builder builder()

serializableBuilderClass

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