java.lang.Object
- software.amazon.awssdk.services.bedrock.model.GuardrailWord

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<GuardrailWord.Builder,GuardrailWord>

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

A word configured for the guardrail.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GuardrailWord.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GuardrailWord.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`GuardrailWordAction`	`inputAction()`	The action to take when harmful content is detected in the input.
`String`	`inputActionAsString()`	The action to take when harmful content is detected in the input.
`Boolean`	`inputEnabled()`	Indicates whether guardrail evaluation is enabled on the input.
`GuardrailWordAction`	`outputAction()`	The action to take when harmful content is detected in the output.
`String`	`outputActionAsString()`	The action to take when harmful content is detected in the output.
`Boolean`	`outputEnabled()`	Indicates whether guardrail evaluation is enabled on the output.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GuardrailWord.Builder>`	`serializableBuilderClass()`
`String`	`text()`	Text of the word configured for the guardrail to block.
`GuardrailWord.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
  - text
```
public final String text()
```
    Text of the word configured for the guardrail to block.
    
    Returns:
    
    Text of the word configured for the guardrail to block.
  - inputAction
```
public final GuardrailWordAction inputAction()
```
    The action to take when harmful content is detected in the input. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    If the service returns an enum value that is not available in the current SDK version, inputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().
    Returns:
    
    The action to take when harmful content is detected in the input. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    See Also:
    
    GuardrailWordAction
  - inputActionAsString
```
public final String inputActionAsString()
```
    The action to take when harmful content is detected in the input. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    If the service returns an enum value that is not available in the current SDK version, inputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().
    Returns:
    
    The action to take when harmful content is detected in the input. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    See Also:
    
    GuardrailWordAction
  - outputAction
```
public final GuardrailWordAction outputAction()
```
    The action to take when harmful content is detected in the output. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    If the service returns an enum value that is not available in the current SDK version, outputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().
    Returns:
    
    The action to take when harmful content is detected in the output. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    See Also:
    
    GuardrailWordAction
  - outputActionAsString
```
public final String outputActionAsString()
```
    The action to take when harmful content is detected in the output. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    If the service returns an enum value that is not available in the current SDK version, outputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().
    Returns:
    
    The action to take when harmful content is detected in the output. Supported values include:
    
    BLOCK – Block the content and replace it with blocked messaging.
    
    NONE – Take no action but return detection information in the trace response.
    
    See Also:
    
    GuardrailWordAction
  - inputEnabled
```
public final Boolean inputEnabled()
```
    Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
    
    Returns:
    
    Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
  - outputEnabled
```
public final Boolean outputEnabled()
```
    Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
    
    Returns:
    
    Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
  - toBuilder
```
public GuardrailWord.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GuardrailWord.Builder,GuardrailWord>
  - builder
```
public static GuardrailWord.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GuardrailWord.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

Class GuardrailWord

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

text

inputAction

inputActionAsString

outputAction

outputActionAsString

inputEnabled

outputEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField