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

Interface GuardrailRegexConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GuardrailRegexConfig.Builder,GuardrailRegexConfig>, SdkBuilder<GuardrailRegexConfig.Builder,GuardrailRegexConfig>, SdkPojo

Enclosing class:

GuardrailRegexConfig

@Mutable
@NotThreadSafe
public static interface GuardrailRegexConfig.Builder
extends SdkPojo, CopyableBuilder<GuardrailRegexConfig.Builder,GuardrailRegexConfig>

Method Summary

Modifier and Type	Method	Description
GuardrailRegexConfig.Builder	action(String action)	The guardrail action to configure when matching regular expression is detected.
GuardrailRegexConfig.Builder	action(GuardrailSensitiveInformationAction action)	The guardrail action to configure when matching regular expression is detected.
GuardrailRegexConfig.Builder	description(String description)	The description of the regular expression to configure for the guardrail.
GuardrailRegexConfig.Builder	inputAction(String inputAction)	Specifies the action to take when harmful content is detected in the input.
GuardrailRegexConfig.Builder	inputAction(GuardrailSensitiveInformationAction inputAction)	Specifies the action to take when harmful content is detected in the input.
GuardrailRegexConfig.Builder	inputEnabled(Boolean inputEnabled)	Specifies whether to enable guardrail evaluation on the input.
GuardrailRegexConfig.Builder	name(String name)	The name of the regular expression to configure for the guardrail.
GuardrailRegexConfig.Builder	outputAction(String outputAction)	Specifies the action to take when harmful content is detected in the output.
GuardrailRegexConfig.Builder	outputAction(GuardrailSensitiveInformationAction outputAction)	Specifies the action to take when harmful content is detected in the output.
GuardrailRegexConfig.Builder	outputEnabled(Boolean outputEnabled)	Specifies whether to enable guardrail evaluation on the output.
GuardrailRegexConfig.Builder	pattern(String pattern)	The regular expression pattern to configure for the guardrail.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

name

GuardrailRegexConfig.Builder name(String name)

The name of the regular expression to configure for the guardrail.

Parameters:

name - The name of the regular expression to configure for the guardrail.

Returns:

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

description

GuardrailRegexConfig.Builder description(String description)

The description of the regular expression to configure for the guardrail.

Parameters:

description - The description of the regular expression to configure for the guardrail.

Returns:

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

pattern

GuardrailRegexConfig.Builder pattern(String pattern)

The regular expression pattern to configure for the guardrail.

Parameters:

pattern - The regular expression pattern to configure for the guardrail.

Returns:

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

action

GuardrailRegexConfig.Builder action(String action)

The guardrail action to configure when matching regular expression is detected.

Parameters:

action - The guardrail action to configure when matching regular expression is detected.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

action

GuardrailRegexConfig.Builder action(GuardrailSensitiveInformationAction action)

The guardrail action to configure when matching regular expression is detected.

Parameters:

action - The guardrail action to configure when matching regular expression is detected.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

inputAction

GuardrailRegexConfig.Builder inputAction(String 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.

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

inputAction

GuardrailRegexConfig.Builder inputAction(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.

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

outputAction

GuardrailRegexConfig.Builder outputAction(String 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.

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

outputAction

GuardrailRegexConfig.Builder outputAction(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.

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

inputEnabled

GuardrailRegexConfig.Builder inputEnabled(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.

Parameters:

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:

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

outputEnabled

GuardrailRegexConfig.Builder outputEnabled(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.

Parameters:

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:

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