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

Interface GuardrailPiiEntity.Builder

All Superinterfaces:

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

Enclosing class:

GuardrailPiiEntity

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

Method Summary

Modifier and Type	Method	Description
GuardrailPiiEntity.Builder	action(String action)	The configured guardrail action when PII entity is detected.
GuardrailPiiEntity.Builder	action(GuardrailSensitiveInformationAction action)	The configured guardrail action when PII entity is detected.
GuardrailPiiEntity.Builder	inputAction(String inputAction)	The action to take when harmful content is detected in the input.
GuardrailPiiEntity.Builder	inputAction(GuardrailSensitiveInformationAction inputAction)	The action to take when harmful content is detected in the input.
GuardrailPiiEntity.Builder	inputEnabled(Boolean inputEnabled)	Indicates whether guardrail evaluation is enabled on the input.
GuardrailPiiEntity.Builder	outputAction(String outputAction)	The action to take when harmful content is detected in the output.
GuardrailPiiEntity.Builder	outputAction(GuardrailSensitiveInformationAction outputAction)	The action to take when harmful content is detected in the output.
GuardrailPiiEntity.Builder	outputEnabled(Boolean outputEnabled)	Indicates whether guardrail evaluation is enabled on the output.
GuardrailPiiEntity.Builder	type(String type)	The type of PII entity.
GuardrailPiiEntity.Builder	type(GuardrailPiiEntityType type)	The type of PII entity.

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

type

GuardrailPiiEntity.Builder type(String type)

The type of PII entity. For example, Social Security Number.

Parameters:

type - The type of PII entity. For example, Social Security Number.

Returns:

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

See Also:

GuardrailPiiEntityType, GuardrailPiiEntityType

type

GuardrailPiiEntity.Builder type(GuardrailPiiEntityType type)

The type of PII entity. For example, Social Security Number.

Parameters:

type - The type of PII entity. For example, Social Security Number.

Returns:

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

See Also:

GuardrailPiiEntityType, GuardrailPiiEntityType

action

GuardrailPiiEntity.Builder action(String action)

The configured guardrail action when PII entity is detected.

Parameters:

action - The configured guardrail action when PII entity is detected.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

action

GuardrailPiiEntity.Builder action(GuardrailSensitiveInformationAction action)

The configured guardrail action when PII entity is detected.

Parameters:

action - The configured guardrail action when PII entity is detected.

Returns:

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

See Also:

GuardrailSensitiveInformationAction, GuardrailSensitiveInformationAction

inputAction

GuardrailPiiEntity.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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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

GuardrailPiiEntity.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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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

GuardrailPiiEntity.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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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

GuardrailPiiEntity.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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• 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

GuardrailPiiEntity.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

GuardrailPiiEntity.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.