Package software.amazon.awssdk.services.comprehend.model

Class EntityLabel

java.lang.Object

software.amazon.awssdk.services.comprehend.model.EntityLabel

All Implemented Interfaces:

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

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

Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityLabel.Builder

Method Summary

Modifier and Type	Method	Description
static EntityLabel.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PiiEntityType	name()	The name of the label.
String	nameAsString()	The name of the label.
Float	score()	The level of confidence that Amazon Comprehend has in the accuracy of the detection.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityLabel.Builder>	serializableBuilderClass()
EntityLabel.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final PiiEntityType name()

The name of the label.

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

Returns:

The name of the label.

See Also:

PiiEntityType

nameAsString

public final String nameAsString()

The name of the label.

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

Returns:

The name of the label.

See Also:

PiiEntityType

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.

toBuilder

public EntityLabel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityLabel.Builder,EntityLabel>

builder

public static EntityLabel.Builder builder()

serializableBuilderClass

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