PiiEntitiesDetectionJobProperties (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class PiiEntitiesDetectionJobProperties
extends java.lang.Object
implements java.io.Serializable
```
Provides information about a PII entities detection job.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PiiEntitiesDetectionJobProperties()

Constructors
Constructor and Description
`PiiEntitiesDetectionJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`java.util.Date`	`getEndTime()` The time that the PII entities detection job completed.
`InputDataConfig`	`getInputDataConfig()` The input properties for a PII entities detection job.
`java.lang.String`	`getJobId()` The identifier assigned to the PII entities detection job.
`java.lang.String`	`getJobName()` The name that you assigned the PII entities detection job.
`java.lang.String`	`getJobStatus()` The current status of the PII entities detection job.
`java.lang.String`	`getLanguageCode()` The language code of the input documents
`java.lang.String`	`getMessage()` A description of the status of a job.
`java.lang.String`	`getMode()` Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
`PiiOutputDataConfig`	`getOutputDataConfig()` The output data configuration that you supplied when you created the PII entities detection job.
`RedactionConfig`	`getRedactionConfig()` Provides configuration parameters for PII entity redaction.
`java.util.Date`	`getSubmitTime()` The time that the PII entities detection job was submitted for processing.
`int`	`hashCode()`
`void`	`setDataAccessRoleArn(java.lang.String dataAccessRoleArn)` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`void`	`setEndTime(java.util.Date endTime)` The time that the PII entities detection job completed.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` The input properties for a PII entities detection job.
`void`	`setJobId(java.lang.String jobId)` The identifier assigned to the PII entities detection job.
`void`	`setJobName(java.lang.String jobName)` The name that you assigned the PII entities detection job.
`void`	`setJobStatus(JobStatus jobStatus)` The current status of the PII entities detection job.
`void`	`setJobStatus(java.lang.String jobStatus)` The current status of the PII entities detection job.
`void`	`setLanguageCode(LanguageCode languageCode)` The language code of the input documents
`void`	`setLanguageCode(java.lang.String languageCode)` The language code of the input documents
`void`	`setMessage(java.lang.String message)` A description of the status of a job.
`void`	`setMode(PiiEntitiesDetectionMode mode)` Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
`void`	`setMode(java.lang.String mode)` Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
`void`	`setOutputDataConfig(PiiOutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the PII entities detection job.
`void`	`setRedactionConfig(RedactionConfig redactionConfig)` Provides configuration parameters for PII entity redaction.
`void`	`setSubmitTime(java.util.Date submitTime)` The time that the PII entities detection job was submitted for processing.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PiiEntitiesDetectionJobProperties`	`withDataAccessRoleArn(java.lang.String dataAccessRoleArn)` The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
`PiiEntitiesDetectionJobProperties`	`withEndTime(java.util.Date endTime)` The time that the PII entities detection job completed.
`PiiEntitiesDetectionJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)` The input properties for a PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withJobId(java.lang.String jobId)` The identifier assigned to the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withJobName(java.lang.String jobName)` The name that you assigned the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withJobStatus(java.lang.String jobStatus)` The current status of the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withLanguageCode(LanguageCode languageCode)` The language code of the input documents
`PiiEntitiesDetectionJobProperties`	`withLanguageCode(java.lang.String languageCode)` The language code of the input documents
`PiiEntitiesDetectionJobProperties`	`withMessage(java.lang.String message)` A description of the status of a job.
`PiiEntitiesDetectionJobProperties`	`withMode(PiiEntitiesDetectionMode mode)` Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
`PiiEntitiesDetectionJobProperties`	`withMode(java.lang.String mode)` Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
`PiiEntitiesDetectionJobProperties`	`withOutputDataConfig(PiiOutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withRedactionConfig(RedactionConfig redactionConfig)` Provides configuration parameters for PII entity redaction.
`PiiEntitiesDetectionJobProperties`	`withSubmitTime(java.util.Date submitTime)` The time that the PII entities detection job was submitted for processing.

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

- Constructor Detail
  - PiiEntitiesDetectionJobProperties
```
public PiiEntitiesDetectionJobProperties()
```
- Method Detail
  - getJobId
```
public java.lang.String getJobId()
```
    The identifier assigned to the PII entities detection job.
    
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The identifier assigned to the PII entities detection job.
  - setJobId
```
public void setJobId(java.lang.String jobId)
```
    The identifier assigned to the PII entities detection job.
    
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobId -
    The identifier assigned to the PII entities detection job.
  - withJobId
```
public PiiEntitiesDetectionJobProperties withJobId(java.lang.String jobId)
```
    The identifier assigned to the PII entities detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobId -
    The identifier assigned to the PII entities detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobName
```
public java.lang.String getJobName()
```
    The name that you assigned the PII entities detection job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The name that you assigned the PII entities detection job.
  - setJobName
```
public void setJobName(java.lang.String jobName)
```
    The name that you assigned the PII entities detection job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name that you assigned the PII entities detection job.
  - withJobName
```
public PiiEntitiesDetectionJobProperties withJobName(java.lang.String jobName)
```
    The name that you assigned the PII entities detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name that you assigned the PII entities detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobStatus
```
public java.lang.String getJobStatus()
```
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Returns:
    
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - setJobStatus
```
public void setJobStatus(java.lang.String jobStatus)
```
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Parameters:
    
    jobStatus -
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public PiiEntitiesDetectionJobProperties withJobStatus(java.lang.String jobStatus)
```
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Parameters:
    
    jobStatus -
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setJobStatus
```
public void setJobStatus(JobStatus jobStatus)
```
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Parameters:
    
    jobStatus -
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public PiiEntitiesDetectionJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    Parameters:
    
    jobStatus -
    The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - getMessage
```
public java.lang.String getMessage()
```
    A description of the status of a job.
    
    Returns:
    
    A description of the status of a job.
  - setMessage
```
public void setMessage(java.lang.String message)
```
    A description of the status of a job.
    
    Parameters:
    
    message -
    A description of the status of a job.
  - withMessage
```
public PiiEntitiesDetectionJobProperties withMessage(java.lang.String message)
```
    A description of the status of a job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    message -
    A description of the status of a job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubmitTime
```
public java.util.Date getSubmitTime()
```
    The time that the PII entities detection job was submitted for processing.
    
    Returns:
    
    The time that the PII entities detection job was submitted for processing.
  - setSubmitTime
```
public void setSubmitTime(java.util.Date submitTime)
```
    The time that the PII entities detection job was submitted for processing.
    
    Parameters:
    
    submitTime -
    The time that the PII entities detection job was submitted for processing.
  - withSubmitTime
```
public PiiEntitiesDetectionJobProperties withSubmitTime(java.util.Date submitTime)
```
    The time that the PII entities detection job was submitted for processing.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    submitTime -
    The time that the PII entities detection job was submitted for processing.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndTime
```
public java.util.Date getEndTime()
```
    The time that the PII entities detection job completed.
    
    Returns:
    
    The time that the PII entities detection job completed.
  - setEndTime
```
public void setEndTime(java.util.Date endTime)
```
    The time that the PII entities detection job completed.
    
    Parameters:
    
    endTime -
    The time that the PII entities detection job completed.
  - withEndTime
```
public PiiEntitiesDetectionJobProperties withEndTime(java.util.Date endTime)
```
    The time that the PII entities detection job completed.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endTime -
    The time that the PII entities detection job completed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input properties for a PII entities detection job.
    
    Returns:
    
    The input properties for a PII entities detection job.
  - setInputDataConfig
```
public void setInputDataConfig(InputDataConfig inputDataConfig)
```
    The input properties for a PII entities detection job.
    
    Parameters:
    
    inputDataConfig -
    The input properties for a PII entities detection job.
  - withInputDataConfig
```
public PiiEntitiesDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input properties for a PII entities detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    inputDataConfig -
    The input properties for a PII entities detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputDataConfig
```
public PiiOutputDataConfig getOutputDataConfig()
```
    The output data configuration that you supplied when you created the PII entities detection job.
    
    Returns:
    
    The output data configuration that you supplied when you created the PII entities detection job.
  - setOutputDataConfig
```
public void setOutputDataConfig(PiiOutputDataConfig outputDataConfig)
```
    The output data configuration that you supplied when you created the PII entities detection job.
    
    Parameters:
    
    outputDataConfig -
    The output data configuration that you supplied when you created the PII entities detection job.
  - withOutputDataConfig
```
public PiiEntitiesDetectionJobProperties withOutputDataConfig(PiiOutputDataConfig outputDataConfig)
```
    The output data configuration that you supplied when you created the PII entities detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outputDataConfig -
    The output data configuration that you supplied when you created the PII entities detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRedactionConfig
```
public RedactionConfig getRedactionConfig()
```
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
    
    Returns:
    
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
  - setRedactionConfig
```
public void setRedactionConfig(RedactionConfig redactionConfig)
```
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
    
    Parameters:
    
    redactionConfig -
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
  - withRedactionConfig
```
public PiiEntitiesDetectionJobProperties withRedactionConfig(RedactionConfig redactionConfig)
```
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    redactionConfig -
    Provides configuration parameters for PII entity redaction.
    
    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLanguageCode
```
public java.lang.String getLanguageCode()
```
    The language code of the input documents
    
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Returns:
    
    The language code of the input documents
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(java.lang.String languageCode)
```
    The language code of the input documents
    
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code of the input documents
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public PiiEntitiesDetectionJobProperties withLanguageCode(java.lang.String languageCode)
```
    The language code of the input documents
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code of the input documents
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(LanguageCode languageCode)
```
    The language code of the input documents
    
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code of the input documents
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public PiiEntitiesDetectionJobProperties withLanguageCode(LanguageCode languageCode)
```
    The language code of the input documents
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code of the input documents
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - getDataAccessRoleArn
```
public java.lang.String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Returns:
    
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Parameters:
    
    dataAccessRoleArn -
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public PiiEntitiesDetectionJobProperties withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Parameters:
    
    dataAccessRoleArn -
    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMode
```
public java.lang.String getMode()
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Constraints:
    Allowed Values: ONLY_REDACTION, ONLY_OFFSETS
    
    Returns:
    
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - setMode
```
public void setMode(java.lang.String mode)
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Constraints:
    Allowed Values: ONLY_REDACTION, ONLY_OFFSETS
    
    Parameters:
    
    mode -
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - withMode
```
public PiiEntitiesDetectionJobProperties withMode(java.lang.String mode)
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ONLY_REDACTION, ONLY_OFFSETS
    
    Parameters:
    
    mode -
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - setMode
```
public void setMode(PiiEntitiesDetectionMode mode)
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Constraints:
    Allowed Values: ONLY_REDACTION, ONLY_OFFSETS
    
    Parameters:
    
    mode -
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - withMode
```
public PiiEntitiesDetectionJobProperties withMode(PiiEntitiesDetectionMode mode)
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ONLY_REDACTION, ONLY_OFFSETS
    
    Parameters:
    
    mode -
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - 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 PiiEntitiesDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PiiEntitiesDetectionJobProperties

Method Detail

getJobId

setJobId

withJobId

getJobName

setJobName

withJobName

getJobStatus

setJobStatus

withJobStatus

setJobStatus

withJobStatus

getMessage

setMessage

withMessage

getSubmitTime

setSubmitTime

withSubmitTime

getEndTime

setEndTime

withEndTime

getInputDataConfig

setInputDataConfig

withInputDataConfig

getOutputDataConfig

setOutputDataConfig

withOutputDataConfig

getRedactionConfig

setRedactionConfig

withRedactionConfig

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

getDataAccessRoleArn

setDataAccessRoleArn

withDataAccessRoleArn

getMode

setMode

withMode

setMode

withMode

toString

hashCode

equals