PiiEntity (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a PII entity.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PiiEntity()

Constructors
Constructor and Description
`PiiEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PiiEntity`	`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.
`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`	`getType()` The entity's 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`	`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`	`setType(String type)` The entity's type.
`String`	`toString()` Returns a string representation of this object.
`PiiEntity`	`withBeginOffset(Integer beginOffset)` The zero-based offset from the beginning of the source text to the first character in the entity.
`PiiEntity`	`withEndOffset(Integer endOffset)` The zero-based offset from the beginning of the source text to the last character in the entity.
`PiiEntity`	`withScore(Float score)` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`PiiEntity`	`withType(PiiEntityType type)` The entity's type.
`PiiEntity`	`withType(String type)` The entity's type.

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

- Constructor Detail
  - PiiEntity
```
public PiiEntity()
```
- 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 PiiEntity 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's type.
    
    Parameters:
    
    type - The entity's type.
    
    See Also:
    
    PiiEntityType
  - getType
```
public String getType()
```
    The entity's type.
    
    Returns:
    
    The entity's type.
    
    See Also:
    
    PiiEntityType
  - withType
```
public PiiEntity withType(String type)
```
    The entity's type.
    
    Parameters:
    
    type - The entity's type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PiiEntityType
  - withType
```
public PiiEntity withType(PiiEntityType type)
```
    The entity's type.
    
    Parameters:
    
    type - The entity's type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PiiEntityType
  - setBeginOffset
```
public void setBeginOffset(Integer beginOffset)
```
    The zero-based offset from the beginning of the source text to the first character in the entity.
    
    Parameters:
    
    beginOffset - The zero-based offset from the beginning of the source text to the first character in the entity.
  - getBeginOffset
```
public Integer getBeginOffset()
```
    The zero-based offset from the beginning of the source text to the first character in the entity.
    
    Returns:
    
    The zero-based offset from the beginning of the source text to the first character in the entity.
  - withBeginOffset
```
public PiiEntity withBeginOffset(Integer beginOffset)
```
    The zero-based offset from the beginning of the source text to the first character in the entity.
    
    Parameters:
    
    beginOffset - The zero-based offset from the beginning of the source text to the first character in the entity.
    
    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.
    
    Parameters:
    
    endOffset - The zero-based offset from the beginning of the source text to the last character in the entity.
  - getEndOffset
```
public Integer getEndOffset()
```
    The zero-based offset from the beginning of the source text to the last character in the entity.
    
    Returns:
    
    The zero-based offset from the beginning of the source text to the last character in the entity.
  - withEndOffset
```
public PiiEntity withEndOffset(Integer endOffset)
```
    The zero-based offset from the beginning of the source text to the last character in the entity.
    
    Parameters:
    
    endOffset - The zero-based offset from the beginning of the source text to the last character in the entity.
    
    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 PiiEntity 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.779

Class PiiEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PiiEntity

Method Detail

setScore

getScore

withScore

setType

getType

withType

withType

setBeginOffset

getBeginOffset

withBeginOffset

setEndOffset

getEndOffset

withEndOffset

toString

equals

hashCode

clone

marshall