Class GuardrailManagedWord

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailManagedWord

All Implemented Interfaces:

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

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

A managed word configured in a guardrail.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailManagedWord.Builder

Method Summary

Modifier and Type	Method	Description
final GuardrailWordPolicyAction	action()	The action for the managed word.
final String	actionAsString()	The action for the managed word.
static GuardrailManagedWord.Builder	builder()
final Boolean	detected()	Indicates whether managed word content that breaches the guardrail configuration is detected.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	match()	The match for the managed word.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailManagedWord.Builder>	serializableBuilderClass()
GuardrailManagedWord.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final GuardrailManagedWordType	type()	The type for the managed word.
final String	typeAsString()	The type for the managed word.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

match

public final String match()

The match for the managed word.

Returns:

The match for the managed word.

type

public final GuardrailManagedWordType type()

The type for the managed word.

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

Returns:

The type for the managed word.

See Also:

• GuardrailManagedWordType

typeAsString

public final String typeAsString()

The type for the managed word.

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

Returns:

The type for the managed word.

See Also:

• GuardrailManagedWordType

action

public final GuardrailWordPolicyAction action()

The action for the managed 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 managed word.

See Also:

• GuardrailWordPolicyAction

actionAsString

public final String actionAsString()

The action for the managed 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 managed word.

See Also:

• GuardrailWordPolicyAction

detected

public final Boolean detected()

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

Returns:

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

toBuilder

public GuardrailManagedWord.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailManagedWord.Builder,GuardrailManagedWord>

Returns:

a builder for type T

builder

public static GuardrailManagedWord.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.