software.amazon.awssdk.services.comprehend.model

Class Entity

java.lang.Object

software.amazon.awssdk.services.comprehend.model.Entity

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Entity.Builder,Entity>

@Generated(value="software.amazon.awssdk:codegen")
public class Entity
extends Object
implements StructuredPojo, ToCopyableBuilder<Entity.Builder,Entity>

Provides information about an entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Entity.Builder

Method Summary

Modifier and Type	Method and Description
Integer	beginOffset() A character offset in the input text that shows where the entity begins (the first character is at position 0).
static Entity.Builder	builder()
Integer	endOffset() A character offset in the input text that shows where the entity ends.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Float	score() The level of confidence that Amazon Comprehend has in the accuracy of the detection.
static Class<? extends Entity.Builder>	serializableBuilderClass()
String	text() The text of the entity.
Entity.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
EntityType	type() The entity's type.
String	typeAsString() The entity's type.

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 Detail

score

public 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 EntityType type()

The entity's type.

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

Returns:

The entity's type.

See Also:

EntityType

typeAsString

public 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 EntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The entity's type.

See Also:

EntityType

text

public String text()

The text of the entity.

Returns:

The text of the entity.

beginOffset

public Integer beginOffset()

A character offset in the input text that shows where the 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 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 Integer endOffset()

A character offset in the input text that shows where the 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 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 Entity.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<Entity.Builder,Entity>

Returns:

a builder for type T

builder

public static Entity.Builder builder()

serializableBuilderClass

public static Class<? extends Entity.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.