Package software.amazon.awssdk.services.bedrockagentruntime.model

Class GuardrailPiiEntityFilter

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.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>

The Guardrail filter to identify and remove personally identifiable information (PII).

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
GuardrailSensitiveInformationPolicyAction	action()	The action of the Guardrail filter to identify and remove PII.
String	actionAsString()	The action of the Guardrail filter to identify and remove PII.
static GuardrailPiiEntityFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	match()	The match to settings in the Guardrail filter to identify and remove PII.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailPiiEntityFilter.Builder>	serializableBuilderClass()
GuardrailPiiEntityFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailPiiEntityType	type()	The type of PII the Guardrail filter has identified and removed.
String	typeAsString()	The type of PII the Guardrail filter has identified and removed.

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

action

public final GuardrailSensitiveInformationPolicyAction action()

The action of the Guardrail filter to identify and remove PII.

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 action of the Guardrail filter to identify and remove PII.

See Also:

GuardrailSensitiveInformationPolicyAction

actionAsString

public final String actionAsString()

The action of the Guardrail filter to identify and remove PII.

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 action of the Guardrail filter to identify and remove PII.

See Also:

GuardrailSensitiveInformationPolicyAction

match

public final String match()

The match to settings in the Guardrail filter to identify and remove PII.

Returns:

The match to settings in the Guardrail filter to identify and remove PII.

type

public final GuardrailPiiEntityType type()

The type of PII the Guardrail filter has identified and removed.

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 type of PII the Guardrail filter has identified and removed.

See Also:

GuardrailPiiEntityType

typeAsString

public final String typeAsString()

The type of PII the Guardrail filter has identified and removed.

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 type of PII the Guardrail filter has identified and removed.

See Also:

GuardrailPiiEntityType

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