Package com.oracle.bmc.ailanguage.model

Class PiiEntity

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
public final class PiiEntity
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    PII entity object.
    Note: Objects should always be created or deserialized using the PiiEntity.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the PiiEntity.Builder, which maintain a set of all explicitly set fields called PiiEntity.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PiiEntity.Builder  

    • Field Summary

      • Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

        EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PiiEntity.Builder builder()
      Create a new builder.
      boolean equals​(Object o)  
      String getId()
      Unique id of the entity.
      Integer getLength()
      Length of PII entity text.
      Integer getOffset()
      The number of Unicode code points preceding this entity in the submitted text.
      String getRelexifyText()
      Redacted entity text
      Double getScore()
      Score or confidence for detected PII entity.
      String getText()
      Entity text like name of person, Organization and so on.
      String getType()
      Entity type supported PERSON ADDRESS AGE DATE_TIME SSN_OR_TAXPAYER EMAIL PASSPORT_NUMBER_US TELEPHONE_NUMBER DRIVER_ID_US BANK_ACCOUNT_NUMBER BANK_SWIFT BANK_ROUTING CREDIT_DEBIT_NUMBER IP_ADDRESS MAC_ADDRESS COOKIE XSRF_TOKEN AUTH_BASIC AUTH_BEARER JSON_WEB_TOKEN PRIVATE_KEY PUBLIC_KEY OCI_OCID_USER OCI_OCID_TENANCY OCI_SMTP_USERNAME OCI_OCID_REFERENCE OCI_FINGERPRINT OCI_CREDENTIAL OCI_PRE_AUTH_REQUEST OCI_STORAGE_SIGNED_URL OCI_CUSTOMER_SECRET_KEY OCI_ACCESS_KEy MEDICAL_RECORD_NUMBER HEALTH_PLAN_ID URL CERTIFICATE_NUMBER FIN GUIDs VEHICLE_LICENSE_PLATE_US VEHICLE_IDENTIFIER_US
      int hashCode()  
      PiiEntity.Builder toBuilder()  
      String toString()  
      String toString​(boolean includeByteArrayContents)
      Return a string representation of the object.

      • Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

        markPropertyAsExplicitlySet, wasPropertyExplicitlySet

    • Method Detail

      • getId

        public String getId()
        Unique id of the entity.
        Returns:
        the value

      • getOffset

        public Integer getOffset()
        The number of Unicode code points preceding this entity in the submitted text.
        Returns:
        the value

      • getLength

        public Integer getLength()
        Length of PII entity text.
        Returns:
        the value

      • getText

        public String getText()
        Entity text like name of person, Organization and so on.
        Returns:
        the value

      • getRelexifyText

        public String getRelexifyText()
        Redacted entity text
        Returns:
        the value

      • getType

        public String getType()
        Entity type supported PERSON ADDRESS AGE DATE_TIME SSN_OR_TAXPAYER EMAIL PASSPORT_NUMBER_US TELEPHONE_NUMBER DRIVER_ID_US BANK_ACCOUNT_NUMBER BANK_SWIFT BANK_ROUTING CREDIT_DEBIT_NUMBER IP_ADDRESS MAC_ADDRESS COOKIE XSRF_TOKEN AUTH_BASIC AUTH_BEARER JSON_WEB_TOKEN PRIVATE_KEY PUBLIC_KEY OCI_OCID_USER OCI_OCID_TENANCY OCI_SMTP_USERNAME OCI_OCID_REFERENCE OCI_FINGERPRINT OCI_CREDENTIAL OCI_PRE_AUTH_REQUEST OCI_STORAGE_SIGNED_URL OCI_CUSTOMER_SECRET_KEY OCI_ACCESS_KEy MEDICAL_RECORD_NUMBER HEALTH_PLAN_ID URL CERTIFICATE_NUMBER FIN GUIDs VEHICLE_LICENSE_PLATE_US VEHICLE_IDENTIFIER_US
        Returns:
        the value

      • getScore

        public Double getScore()
        Score or confidence for detected PII entity.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel