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

Interface GuardrailRegex.Builder

All Superinterfaces:

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

Enclosing class:

GuardrailRegex

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

Method Summary

Modifier and Type	Method	Description
GuardrailRegex.Builder	action(String action)	The action taken when a match to the regular expression is detected.
GuardrailRegex.Builder	action(GuardrailSensitiveInformationAction action)	The action taken when a match to the regular expression is detected.
GuardrailRegex.Builder	description(String description)	The description of the regular expression for the guardrail.
GuardrailRegex.Builder	inputAction(String inputAction)	The action to take when harmful content is detected in the input.
GuardrailRegex.Builder	inputAction(GuardrailSensitiveInformationAction inputAction)	The action to take when harmful content is detected in the input.
GuardrailRegex.Builder	inputEnabled(Boolean inputEnabled)	Indicates whether guardrail evaluation is enabled on the input.
GuardrailRegex.Builder	name(String name)	The name of the regular expression for the guardrail.
GuardrailRegex.Builder	outputAction(String outputAction)	The action to take when harmful content is detected in the output.
GuardrailRegex.Builder	outputAction(GuardrailSensitiveInformationAction outputAction)	The action to take when harmful content is detected in the output.
GuardrailRegex.Builder	outputEnabled(Boolean outputEnabled)	Indicates whether guardrail evaluation is enabled on the output.
GuardrailRegex.Builder	pattern(String pattern)	The pattern of the regular expression configured 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

GuardrailRegex.Builder name(String name)

The name of the regular expression for the guardrail.

Parameters:

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

Returns:

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

description

GuardrailRegex.Builder description(String description)

The description of the regular expression for the guardrail.

Parameters:

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

Returns:

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

pattern

GuardrailRegex.Builder pattern(String pattern)

The pattern of the regular expression configured for the guardrail.

Parameters:

pattern - The pattern of the regular expression configured for the guardrail.

Returns:

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

action

GuardrailRegex.Builder action(String action)

The action taken when a match to the regular expression is detected.

Parameters:

action - The action taken when a match to the regular expression is detected.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

action

GuardrailRegex.Builder action(GuardrailSensitiveInformationAction action)

The action taken when a match to the regular expression is detected.

Parameters:

action - The action taken when a match to the regular expression is detected.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

inputAction

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

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

inputAction

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

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

outputAction

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

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

outputAction

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

Parameters:

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.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

inputEnabled

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

Parameters:

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:

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

outputEnabled

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

Parameters:

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:

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