Package software.amazon.awssdk.services.bedrock.model

Class GuardrailWordPolicy

java.lang.Object

software.amazon.awssdk.services.bedrock.model.GuardrailWordPolicy

All Implemented Interfaces:

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

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

Contains details about the word policy configured for the guardrail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailWordPolicy.Builder

Method Summary

Modifier and Type	Method	Description
static GuardrailWordPolicy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasManagedWordLists()	For responses, this returns true if the service returned a value for the ManagedWordLists property.
boolean	hasWords()	For responses, this returns true if the service returned a value for the Words property.
List<GuardrailManagedWords>	managedWordLists()	A list of managed words configured for the guardrail.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailWordPolicy.Builder>	serializableBuilderClass()
GuardrailWordPolicy.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<GuardrailWord>	words()	A list of words configured 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 Detail

hasWords

public final boolean hasWords()

For responses, this returns true if the service returned a value for the Words property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

words

public final List<GuardrailWord> words()

A list of words configured for the guardrail.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWords() method.

Returns:

A list of words configured for the guardrail.

hasManagedWordLists

public final boolean hasManagedWordLists()

For responses, this returns true if the service returned a value for the ManagedWordLists property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

managedWordLists

public final List<GuardrailManagedWords> managedWordLists()

A list of managed words configured for the guardrail.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasManagedWordLists() method.

Returns:

A list of managed words configured for the guardrail.

toBuilder

public GuardrailWordPolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailWordPolicy.Builder,GuardrailWordPolicy>

builder

public static GuardrailWordPolicy.Builder builder()

serializableBuilderClass

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