Package software.amazon.awssdk.services.bedrockruntime.model

Class GuardrailPiiEntityFilter

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailPiiEntityFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GuardrailPiiEntityFilter.Builder,GuardrailPiiEntityFilter>

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

A Personally Identifiable Information (PII) entity configured in a guardrail.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailPiiEntityFilter.Builder

Method Summary

Modifier and Type	Method	Description
final GuardrailSensitiveInformationPolicyAction	action()	The PII entity filter action.
final String	actionAsString()	The PII entity filter action.
static GuardrailPiiEntityFilter.Builder	builder()
final Boolean	detected()	Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	match()	The PII entity filter match.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailPiiEntityFilter.Builder>	serializableBuilderClass()
GuardrailPiiEntityFilter.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final GuardrailPiiEntityType	type()	The PII entity filter type.
final String	typeAsString()	The PII entity filter type.

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 Details

match

public final String match()

The PII entity filter match.

Returns:

The PII entity filter match.

type

public final GuardrailPiiEntityType type()

The PII entity filter type.

If the service returns an enum value that is not available in the current SDK version, type will return GuardrailPiiEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The PII entity filter type.

See Also:

• GuardrailPiiEntityType

typeAsString

public final String typeAsString()

The PII entity filter type.

If the service returns an enum value that is not available in the current SDK version, type will return GuardrailPiiEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The PII entity filter type.

See Also:

• GuardrailPiiEntityType

action

public final GuardrailSensitiveInformationPolicyAction action()

The PII entity filter action.

If the service returns an enum value that is not available in the current SDK version, action will return GuardrailSensitiveInformationPolicyAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The PII entity filter action.

See Also:

• GuardrailSensitiveInformationPolicyAction

actionAsString

public final String actionAsString()

The PII entity filter action.

If the service returns an enum value that is not available in the current SDK version, action will return GuardrailSensitiveInformationPolicyAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The PII entity filter action.

See Also:

• GuardrailSensitiveInformationPolicyAction

detected

public final Boolean detected()

Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.

Returns:

Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.

toBuilder

public GuardrailPiiEntityFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailPiiEntityFilter.Builder,GuardrailPiiEntityFilter>

builder

public static GuardrailPiiEntityFilter.Builder builder()

serializableBuilderClass

public static Class<? extends GuardrailPiiEntityFilter.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