Entity (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehend.model.Entity

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Entity
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides information about an entity.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Entity()

Constructors
Constructor and Description
`Entity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entity`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBeginOffset()` The zero-based offset from the beginning of the source text to the first character in the entity.
`List<BlockReference>`	`getBlockReferences()` A reference to each block for this entity.
`Integer`	`getEndOffset()` The zero-based offset from the beginning of the source text to the last character in the entity.
`Float`	`getScore()` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`String`	`getText()` The text of the entity.
`String`	`getType()` The entity type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBeginOffset(Integer beginOffset)` The zero-based offset from the beginning of the source text to the first character in the entity.
`void`	`setBlockReferences(Collection<BlockReference> blockReferences)` A reference to each block for this entity.
`void`	`setEndOffset(Integer endOffset)` The zero-based offset from the beginning of the source text to the last character in the entity.
`void`	`setScore(Float score)` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`void`	`setText(String text)` The text of the entity.
`void`	`setType(String type)` The entity type.
`String`	`toString()` Returns a string representation of this object.
`Entity`	`withBeginOffset(Integer beginOffset)` The zero-based offset from the beginning of the source text to the first character in the entity.
`Entity`	`withBlockReferences(BlockReference... blockReferences)` A reference to each block for this entity.
`Entity`	`withBlockReferences(Collection<BlockReference> blockReferences)` A reference to each block for this entity.
`Entity`	`withEndOffset(Integer endOffset)` The zero-based offset from the beginning of the source text to the last character in the entity.
`Entity`	`withScore(Float score)` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`Entity`	`withText(String text)` The text of the entity.
`Entity`	`withType(EntityType type)` The entity type.
`Entity`	`withType(String type)` The entity type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Entity
```
public Entity()
```
- Method Detail
  - setScore
```
public void setScore(Float score)
```
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Parameters:
    
    score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.
  - getScore
```
public Float getScore()
```
    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.
  - withScore
```
public Entity withScore(Float score)
```
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Parameters:
    
    score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    Parameters:
    
    type - The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    See Also:
    
    EntityType
  - getType
```
public String getType()
```
    The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    Returns:
    
    The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    See Also:
    
    EntityType
  - withType
```
public Entity withType(String type)
```
    The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    Parameters:
    
    type - The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntityType
  - withType
```
public Entity withType(EntityType type)
```
    The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    Parameters:
    
    type - The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
    
    For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntityType
  - setText
```
public void setText(String text)
```
    The text of the entity.
    
    Parameters:
    
    text - The text of the entity.
  - getText
```
public String getText()
```
    The text of the entity.
    
    Returns:
    
    The text of the entity.
  - withText
```
public Entity withText(String text)
```
    The text of the entity.
    
    Parameters:
    
    text - The text of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBeginOffset
```
public void setBeginOffset(Integer beginOffset)
```
    The zero-based offset from the beginning of the source text to the first character in the entity.
    
    This field is empty for non-text input.
    
    Parameters:
    
    beginOffset - The zero-based offset from the beginning of the source text to the first character in the entity.
    
    This field is empty for non-text input.
  - getBeginOffset
```
public Integer getBeginOffset()
```
    The zero-based offset from the beginning of the source text to the first character in the entity.
    
    This field is empty for non-text input.
    
    Returns:
    
    The zero-based offset from the beginning of the source text to the first character in the entity.
    
    This field is empty for non-text input.
  - withBeginOffset
```
public Entity withBeginOffset(Integer beginOffset)
```
    The zero-based offset from the beginning of the source text to the first character in the entity.
    
    This field is empty for non-text input.
    
    Parameters:
    
    beginOffset - The zero-based offset from the beginning of the source text to the first character in the entity.
    
    This field is empty for non-text input.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndOffset
```
public void setEndOffset(Integer endOffset)
```
    The zero-based offset from the beginning of the source text to the last character in the entity.
    
    This field is empty for non-text input.
    
    Parameters:
    
    endOffset - The zero-based offset from the beginning of the source text to the last character in the entity.
    
    This field is empty for non-text input.
  - getEndOffset
```
public Integer getEndOffset()
```
    The zero-based offset from the beginning of the source text to the last character in the entity.
    
    This field is empty for non-text input.
    
    Returns:
    
    The zero-based offset from the beginning of the source text to the last character in the entity.
    
    This field is empty for non-text input.
  - withEndOffset
```
public Entity withEndOffset(Integer endOffset)
```
    The zero-based offset from the beginning of the source text to the last character in the entity.
    
    This field is empty for non-text input.
    
    Parameters:
    
    endOffset - The zero-based offset from the beginning of the source text to the last character in the entity.
    
    This field is empty for non-text input.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBlockReferences
```
public List<BlockReference> getBlockReferences()
```
    A reference to each block for this entity. This field is empty for plain-text input.
    
    Returns:
    
    A reference to each block for this entity. This field is empty for plain-text input.
  - setBlockReferences
```
public void setBlockReferences(Collection<BlockReference> blockReferences)
```
    A reference to each block for this entity. This field is empty for plain-text input.
    
    Parameters:
    
    blockReferences - A reference to each block for this entity. This field is empty for plain-text input.
  - withBlockReferences
```
public Entity withBlockReferences(BlockReference... blockReferences)
```
    A reference to each block for this entity. This field is empty for plain-text input.
    
    NOTE: This method appends the values to the existing list (if any). Use setBlockReferences(java.util.Collection) or withBlockReferences(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    blockReferences - A reference to each block for this entity. This field is empty for plain-text input.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBlockReferences
```
public Entity withBlockReferences(Collection<BlockReference> blockReferences)
```
    A reference to each block for this entity. This field is empty for plain-text input.
    
    Parameters:
    
    blockReferences - A reference to each block for this entity. This field is empty for plain-text input.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Entity clone()
```
    Overrides:
    
    clone in class Object
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Entity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Entity

Method Detail

setScore

getScore

withScore

setType

getType

withType

withType

setText

getText

withText

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

getBlockReferences

setBlockReferences

withBlockReferences

withBlockReferences

toString

equals

hashCode

clone

marshall