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
final GuardrailSensitiveInformationAction	action()	The configured guardrail action when PII entity is detected.
final String	actionAsString()	The configured guardrail action when PII entity is detected.
static GuardrailPiiEntity.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailPiiEntity.Builder>	serializableBuilderClass()
GuardrailPiiEntity.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final GuardrailPiiEntityType	type()	The type of PII entity.
final String	typeAsString()	The type of PII entity.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

type

public final GuardrailPiiEntityType type()

The type of PII entity. For exampvle, 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 exampvle, Social Security Number.

See Also:

• GuardrailPiiEntityType

typeAsString

public final String typeAsString()

The type of PII entity. For exampvle, 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 exampvle, 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailPiiEntity.Builder,GuardrailPiiEntity>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.