com.amazonaws.services.bedrock.model

Class GuardrailWordPolicy

java.lang.Object

com.amazonaws.services.bedrock.model.GuardrailWordPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GuardrailWordPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains details about the word policy configured for the guardrail.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GuardrailWordPolicy()

Method Summary

Modifier and Type	Method and Description
GuardrailWordPolicy	clone()
boolean	equals(Object obj)
List<GuardrailManagedWords>	getManagedWordLists() A list of managed words configured for the guardrail.
List<GuardrailWord>	getWords() A list of words configured for the guardrail.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setManagedWordLists(Collection<GuardrailManagedWords> managedWordLists) A list of managed words configured for the guardrail.
void	setWords(Collection<GuardrailWord> words) A list of words configured for the guardrail.
String	toString() Returns a string representation of this object.
GuardrailWordPolicy	withManagedWordLists(Collection<GuardrailManagedWords> managedWordLists) A list of managed words configured for the guardrail.
GuardrailWordPolicy	withManagedWordLists(GuardrailManagedWords... managedWordLists) A list of managed words configured for the guardrail.
GuardrailWordPolicy	withWords(Collection<GuardrailWord> words) A list of words configured for the guardrail.
GuardrailWordPolicy	withWords(GuardrailWord... words) A list of words configured for the guardrail.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GuardrailWordPolicy

public GuardrailWordPolicy()

Method Detail

getWords

public List<GuardrailWord> getWords()

A list of words configured for the guardrail.

Returns:

A list of words configured for the guardrail.

setWords

public void setWords(Collection<GuardrailWord> words)

A list of words configured for the guardrail.

Parameters:

words - A list of words configured for the guardrail.

withWords

public GuardrailWordPolicy withWords(GuardrailWord... words)

A list of words configured for the guardrail.

NOTE: This method appends the values to the existing list (if any). Use setWords(java.util.Collection) or withWords(java.util.Collection) if you want to override the existing values.

Parameters:

words - A list of words configured for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

withWords

public GuardrailWordPolicy withWords(Collection<GuardrailWord> words)

A list of words configured for the guardrail.

Parameters:

words - A list of words configured for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

getManagedWordLists

public List<GuardrailManagedWords> getManagedWordLists()

A list of managed words configured for the guardrail.

Returns:

A list of managed words configured for the guardrail.

setManagedWordLists

public void setManagedWordLists(Collection<GuardrailManagedWords> managedWordLists)

A list of managed words configured for the guardrail.

Parameters:

managedWordLists - A list of managed words configured for the guardrail.

withManagedWordLists

public GuardrailWordPolicy withManagedWordLists(GuardrailManagedWords... managedWordLists)

A list of managed words configured for the guardrail.

NOTE: This method appends the values to the existing list (if any). Use setManagedWordLists(java.util.Collection) or withManagedWordLists(java.util.Collection) if you want to override the existing values.

Parameters:

managedWordLists - A list of managed words configured for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

withManagedWordLists

public GuardrailWordPolicy withManagedWordLists(Collection<GuardrailManagedWords> managedWordLists)

A list of managed words configured for the guardrail.

Parameters:

managedWordLists - A list of managed words configured for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GuardrailWordPolicy clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.