PiiEntity (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class PiiEntity
extends java.lang.Object
implements java.io.Serializable
```
Provides information about a PII entity.

See Also:

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
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getBeginOffset()` A character offset in the input text that shows where the PII entity begins (the first character is at position 0).
`java.lang.Integer`	`getEndOffset()` A character offset in the input text that shows where the PII entity ends.
`java.lang.Float`	`getScore()` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`java.lang.String`	`getType()` The entity's type.
`int`	`hashCode()`
`void`	`setBeginOffset(java.lang.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(java.lang.Integer endOffset)` A character offset in the input text that shows where the PII entity ends.
`void`	`setScore(java.lang.Float score)` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`void`	`setType(PiiEntityType type)` The entity's type.
`void`	`setType(java.lang.String type)` The entity's type.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PiiEntity`	`withBeginOffset(java.lang.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(java.lang.Integer endOffset)` A character offset in the input text that shows where the PII entity ends.
`PiiEntity`	`withScore(java.lang.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(java.lang.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
  - getScore
```
public java.lang.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.
  - setScore
```
public void setScore(java.lang.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.
  - withScore
```
public PiiEntity withScore(java.lang.Float score)
```
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    score -
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getType
```
public java.lang.String getType()
```
    The entity's type.
    
    Constraints:
    Allowed Values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
    
    Returns:
    
    The entity's type.
    
    See Also:
    
    PiiEntityType
  - setType
```
public void setType(java.lang.String type)
```
    The entity's type.
    
    Constraints:
    Allowed Values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
    
    Parameters:
    
    type -
    The entity's type.
    
    See Also:
    
    PiiEntityType
  - withType
```
public PiiEntity withType(java.lang.String type)
```
    The entity's type.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
    
    Parameters:
    
    type -
    The entity's type.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    PiiEntityType
  - setType
```
public void setType(PiiEntityType type)
```
    The entity's type.
    
    Constraints:
    Allowed Values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
    
    Parameters:
    
    type -
    The entity's type.
    
    See Also:
    
    PiiEntityType
  - withType
```
public PiiEntity withType(PiiEntityType type)
```
    The entity's type.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
    
    Parameters:
    
    type -
    The entity's type.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    PiiEntityType
  - getBeginOffset
```
public java.lang.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.
  - setBeginOffset
```
public void setBeginOffset(java.lang.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.
  - withBeginOffset
```
public PiiEntity withBeginOffset(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndOffset
```
public java.lang.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.
  - setEndOffset
```
public void setEndOffset(java.lang.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.
  - withEndOffset
```
public PiiEntity withEndOffset(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class PiiEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PiiEntity

Method Detail

getScore

setScore

withScore

getType

setType

withType

setType

withType

getBeginOffset

setBeginOffset

withBeginOffset

getEndOffset

setEndOffset

withEndOffset

toString

hashCode

equals