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

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

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

The regular expression to configure for the guardrail.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GuardrailRegexConfig.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GuardrailSensitiveInformationAction`	`action()`	The guardrail action to configure when matching regular expression is detected.
`String`	`actionAsString()`	The guardrail action to configure when matching regular expression is detected.
`static GuardrailRegexConfig.Builder`	`builder()`
`String`	`description()`	The description of the regular expression to configure for the guardrail.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`GuardrailSensitiveInformationAction`	`inputAction()`	Specifies the action to take when harmful content is detected in the input.
`String`	`inputActionAsString()`	Specifies the action to take when harmful content is detected in the input.
`Boolean`	`inputEnabled()`	Specifies whether to enable guardrail evaluation on the input.
`String`	`name()`	The name of the regular expression to configure for the guardrail.
`GuardrailSensitiveInformationAction`	`outputAction()`	Specifies the action to take when harmful content is detected in the output.
`String`	`outputActionAsString()`	Specifies the action to take when harmful content is detected in the output.
`Boolean`	`outputEnabled()`	Specifies whether to enable guardrail evaluation on the output.
`String`	`pattern()`	The regular expression pattern to configure for the guardrail.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GuardrailRegexConfig.Builder>`	`serializableBuilderClass()`
`GuardrailRegexConfig.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
  - name
```
public final String name()
```
    The name of the regular expression to configure for the guardrail.
    
    Returns:
    
    The name of the regular expression to configure for the guardrail.
  - description
```
public final String description()
```
    The description of the regular expression to configure for the guardrail.
    
    Returns:
    
    The description of the regular expression to configure for the guardrail.
  - pattern
```
public final String pattern()
```
    The regular expression pattern to configure for the guardrail.
    
    Returns:
    
    The regular expression pattern to configure for the guardrail.
  - action
```
public final GuardrailSensitiveInformationAction action()
```
    The guardrail action to configure when matching regular expression is detected.
    
    If the service returns an enum value that is not available in the current SDK version, action will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The guardrail action to configure when matching regular expression is detected.
    
    See Also:
    
    GuardrailSensitiveInformationAction
  - actionAsString
```
public final String actionAsString()
```
    The guardrail action to configure when matching regular expression is detected.
    
    If the service returns an enum value that is not available in the current SDK version, action will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The guardrail action to configure when matching regular expression is detected.
    
    See Also:
    
    GuardrailSensitiveInformationAction
  - inputAction
```
public final GuardrailSensitiveInformationAction inputAction()
```
    Specifies 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 GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().
    Returns:
    
    Specifies 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:
    
    GuardrailSensitiveInformationAction
  - inputActionAsString
```
public final String inputActionAsString()
```
    Specifies 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 GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().
    Returns:
    
    Specifies 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:
    
    GuardrailSensitiveInformationAction
  - outputAction
```
public final GuardrailSensitiveInformationAction outputAction()
```
    Specifies 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 GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().
    Returns:
    
    Specifies 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:
    
    GuardrailSensitiveInformationAction
  - outputActionAsString
```
public final String outputActionAsString()
```
    Specifies 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 GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().
    Returns:
    
    Specifies 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:
    
    GuardrailSensitiveInformationAction
  - inputEnabled
```
public final Boolean inputEnabled()
```
    Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
    
    Returns:
    
    Specifies whether to enable guardrail evaluation 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()
```
    Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
    
    Returns:
    
    Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
  - toBuilder
```
public GuardrailRegexConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GuardrailRegexConfig.Builder,GuardrailRegexConfig>
  - builder
```
public static GuardrailRegexConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GuardrailRegexConfig.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 GuardrailRegexConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

description

pattern

action

actionAsString

inputAction

inputActionAsString

outputAction

outputActionAsString

inputEnabled

outputEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField