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

Class GuardrailPiiEntity

java.lang.Object

software.amazon.awssdk.services.bedrock.model.GuardrailPiiEntity

All Implemented Interfaces:

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

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

The PII entity configured for the guardrail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailPiiEntity.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailSensitiveInformationAction	action()	The configured guardrail action when PII entity is detected.
String	actionAsString()	The configured guardrail action when PII entity is detected.
static GuardrailPiiEntity.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailPiiEntity.Builder>	serializableBuilderClass()
GuardrailPiiEntity.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailPiiEntityType	type()	The type of PII entity.
String	typeAsString()	The type of PII entity.

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

type

public final GuardrailPiiEntityType type()

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

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 entity. For example, Social Security Number.

See Also:

GuardrailPiiEntityType

typeAsString

public final String typeAsString()

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

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 entity. For example, Social Security Number.

See Also:

GuardrailPiiEntityType

action

public final GuardrailSensitiveInformationAction action()

The configured guardrail action when PII entity is detected.

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

Returns:

The configured guardrail action when PII entity is detected.

See Also:

GuardrailSensitiveInformationAction

actionAsString

public final String actionAsString()

The configured guardrail action when PII entity is detected.

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

Returns:

The configured guardrail action when PII entity is detected.

See Also:

GuardrailSensitiveInformationAction

toBuilder

public GuardrailPiiEntity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailPiiEntity.Builder,GuardrailPiiEntity>

builder

public static GuardrailPiiEntity.Builder builder()

serializableBuilderClass

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