PiiEntitiesDetectionJobProperties (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a PII entities detection job.

See Also:: AWS API Documentation, 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
`PiiEntitiesDetectionJobProperties`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`Date`	`getEndTime()` The time that the PII entities detection job completed.
`InputDataConfig`	`getInputDataConfig()` The input properties for a PII entities detection job.
`String`	`getJobArn()` The Amazon Resource Name (ARN) of the PII entities detection job.
`String`	`getJobId()` The identifier assigned to the PII entities detection job.
`String`	`getJobName()` The name that you assigned the PII entities detection job.
`String`	`getJobStatus()` The current status of the PII entities detection job.
`String`	`getLanguageCode()` The language code of the input documents.
`String`	`getMessage()` A description of the status of a job.
`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.
`Date`	`getSubmitTime()` The time that the PII entities detection job was submitted for processing.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`void`	`setEndTime(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`	`setJobArn(String jobArn)` The Amazon Resource Name (ARN) of the PII entities detection job.
`void`	`setJobId(String jobId)` The identifier assigned to the PII entities detection job.
`void`	`setJobName(String jobName)` The name that you assigned the PII entities detection job.
`void`	`setJobStatus(String jobStatus)` The current status of the PII entities detection job.
`void`	`setLanguageCode(String languageCode)` The language code of the input documents.
`void`	`setMessage(String message)` A description of the status of a job.
`void`	`setMode(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(Date submitTime)` The time that the PII entities detection job was submitted for processing.
`String`	`toString()` Returns a string representation of this object.
`PiiEntitiesDetectionJobProperties`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`PiiEntitiesDetectionJobProperties`	`withEndTime(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`	`withJobArn(String jobArn)` The Amazon Resource Name (ARN) of the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withJobId(String jobId)` The identifier assigned to the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withJobName(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(String jobStatus)` The current status of the PII entities detection job.
`PiiEntitiesDetectionJobProperties`	`withLanguageCode(LanguageCode languageCode)` The language code of the input documents.
`PiiEntitiesDetectionJobProperties`	`withLanguageCode(String languageCode)` The language code of the input documents.
`PiiEntitiesDetectionJobProperties`	`withMessage(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(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(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
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the PII entities detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the PII entities detection job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the PII entities detection job.
    
    Returns:
    
    The identifier assigned to the PII entities detection job.
  - withJobId
```
public PiiEntitiesDetectionJobProperties withJobId(String jobId)
```
    The identifier assigned to the PII entities detection job.
    
    Parameters:
    
    jobId - The identifier assigned to the PII entities detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobArn
```
public void setJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
  - getJobArn
```
public String getJobArn()
```
    The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
  - withJobArn
```
public PiiEntitiesDetectionJobProperties withJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobName
```
public void setJobName(String jobName)
```
    The name that you assigned the PII entities detection job.
    
    Parameters:
    
    jobName - The name that you assigned the PII entities detection job.
  - getJobName
```
public String getJobName()
```
    The name that you assigned the PII entities detection job.
    
    Returns:
    
    The name that you assigned the PII entities detection job.
  - withJobName
```
public PiiEntitiesDetectionJobProperties withJobName(String jobName)
```
    The name that you assigned the PII entities detection job.
    
    Parameters:
    
    jobName - The name that you assigned the PII entities detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobStatus
```
public void setJobStatus(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.
    
    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
  - getJobStatus
```
public 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.
    
    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
  - withJobStatus
```
public PiiEntitiesDetectionJobProperties withJobStatus(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setMessage
```
public void setMessage(String message)
```
    A description of the status of a job.
    
    Parameters:
    
    message - A description of the status of a job.
  - getMessage
```
public String getMessage()
```
    A description of the status of a job.
    
    Returns:
    
    A description of the status of a job.
  - withMessage
```
public PiiEntitiesDetectionJobProperties withMessage(String message)
```
    A description of the status of a job.
    
    Parameters:
    
    message - A description of the status of a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubmitTime
```
public void setSubmitTime(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.
  - getSubmitTime
```
public 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.
  - withSubmitTime
```
public PiiEntitiesDetectionJobProperties withSubmitTime(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The time that the PII entities detection job completed.
    
    Parameters:
    
    endTime - The time that the PII entities detection job completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that the PII entities detection job completed.
    
    Returns:
    
    The time that the PII entities detection job completed.
  - withEndTime
```
public PiiEntitiesDetectionJobProperties withEndTime(Date endTime)
```
    The time that the PII entities detection job completed.
    
    Parameters:
    
    endTime - The time that the PII entities detection job completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input properties for a PII entities detection job.
    
    Returns:
    
    The input properties for a PII entities detection job.
  - withInputDataConfig
```
public PiiEntitiesDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input properties for a PII entities detection job.
    
    Parameters:
    
    inputDataConfig - The input properties for a PII entities detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withOutputDataConfig
```
public PiiEntitiesDetectionJobProperties withOutputDataConfig(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code of the input documents.
    
    Parameters:
    
    languageCode - The language code of the input documents.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code of the input documents.
    
    Returns:
    
    The language code of the input documents.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public PiiEntitiesDetectionJobProperties withLanguageCode(String languageCode)
```
    The language code of the input documents.
    
    Parameters:
    
    languageCode - The language code of the input documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public PiiEntitiesDetectionJobProperties withLanguageCode(LanguageCode languageCode)
```
    The language code of the input documents.
    
    Parameters:
    
    languageCode - The language code of the input documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public PiiEntitiesDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMode
```
public void setMode(String mode)
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    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
  - getMode
```
public String getMode()
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Returns:
    
    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(String mode)
```
    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Parameters:
    
    mode - Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    Parameters:
    
    mode - Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PiiEntitiesDetectionMode
  - 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 PiiEntitiesDetectionJobProperties 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 PiiEntitiesDetectionJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PiiEntitiesDetectionJobProperties

Method Detail

setJobId

getJobId

withJobId

setJobArn

getJobArn

withJobArn

setJobName

getJobName

withJobName

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setInputDataConfig

getInputDataConfig

withInputDataConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

setRedactionConfig

getRedactionConfig

withRedactionConfig

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setMode

getMode

withMode

withMode

toString

equals

hashCode

clone

marshall