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()` A character offset in the input text that shows where the PII entity begins (the first character is at position 0).
`Integer`	`getEndOffset()` A character offset in the input text that shows where the PII entity ends.
`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)` A character offset in the input text that shows where the PII entity begins (the first character is at position 0).
`void`	`setEndOffset(Integer endOffset)` A character offset in the input text that shows where the PII entity ends.
`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)` A character offset in the input text that shows where the PII entity begins (the first character is at position 0).
`PiiEntity`	`withEndOffset(Integer endOffset)` A character offset in the input text that shows where the PII entity ends.
`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)
```
    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.
    
    Parameters:
    
    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.
  - getBeginOffset
```
public Integer getBeginOffset()
```
    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.
  - withBeginOffset
```
public PiiEntity withBeginOffset(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndOffset
```
public void setEndOffset(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.
    
    Parameters:
    
    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.
  - getEndOffset
```
public Integer getEndOffset()
```
    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.
  - withEndOffset
```
public PiiEntity withEndOffset(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.
    
    Parameters:
    
    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:
    
    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.

Did this page help you?

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