software.amazon.awssdk.services.comprehend.model

Class PiiEntity

java.lang.Object

software.amazon.awssdk.services.comprehend.model.PiiEntity

All Implemented Interfaces:

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

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

Provides information about a PII entity.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PiiEntity.Builder

Method Summary

Modifier and Type	Method and Description
Integer	beginOffset() A character offset in the input text that shows where the PII entity begins (the first character is at position 0).
static PiiEntity.Builder	builder()
Integer	endOffset() A character offset in the input text that shows where the PII entity ends.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Float	score() The level of confidence that Amazon Comprehend has in the accuracy of the detection.
List<SdkField<?>>	sdkFields()
static Class<? extends PiiEntity.Builder>	serializableBuilderClass()
PiiEntity.Builder	toBuilder()
String	toString() Returns a string representation of this object.
PiiEntityType	type() The entity's type.
String	typeAsString() The entity's 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 Detail

score

public final Float score()

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

type

public final PiiEntityType type()

The entity's type.

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

Returns:

The entity's type.

See Also:

PiiEntityType

typeAsString

public final String typeAsString()

The entity's type.

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

Returns:

The entity's type.

See Also:

PiiEntityType

beginOffset

public final Integer beginOffset()

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

endOffset

public final Integer endOffset()

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

toBuilder

public PiiEntity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PiiEntity.Builder,PiiEntity>

builder

public static PiiEntity.Builder builder()

serializableBuilderClass

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