com.amazonaws.services.comprehend.model

Class StartPiiEntitiesDetectionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.StartPiiEntitiesDetectionJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartPiiEntitiesDetectionJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Starts an asynchronous PII entity detection job for a collection of documents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartPiiEntitiesDetectionJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientRequestToken() A unique identifier for the request.
java.lang.String	getDataAccessRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
InputDataConfig	getInputDataConfig() The input properties for a PII entities detection job.
java.lang.String	getJobName() The identifier of the job.
java.lang.String	getLanguageCode() The language of the input documents.
java.lang.String	getMode() Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
OutputDataConfig	getOutputDataConfig() Provides configuration parameters for the output of PII entity detection jobs.
RedactionConfig	getRedactionConfig() Provides configuration parameters for PII entity redaction.
int	hashCode()
void	setClientRequestToken(java.lang.String clientRequestToken) A unique identifier for the request.
void	setDataAccessRoleArn(java.lang.String dataAccessRoleArn) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
void	setInputDataConfig(InputDataConfig inputDataConfig) The input properties for a PII entities detection job.
void	setJobName(java.lang.String jobName) The identifier of the job.
void	setLanguageCode(LanguageCode languageCode) The language of the input documents.
void	setLanguageCode(java.lang.String languageCode) The language of the input documents.
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(OutputDataConfig outputDataConfig) Provides configuration parameters for the output of PII entity detection jobs.
void	setRedactionConfig(RedactionConfig redactionConfig) Provides configuration parameters for PII entity redaction.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartPiiEntitiesDetectionJobRequest	withClientRequestToken(java.lang.String clientRequestToken) A unique identifier for the request.
StartPiiEntitiesDetectionJobRequest	withDataAccessRoleArn(java.lang.String dataAccessRoleArn) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
StartPiiEntitiesDetectionJobRequest	withInputDataConfig(InputDataConfig inputDataConfig) The input properties for a PII entities detection job.
StartPiiEntitiesDetectionJobRequest	withJobName(java.lang.String jobName) The identifier of the job.
StartPiiEntitiesDetectionJobRequest	withLanguageCode(LanguageCode languageCode) The language of the input documents.
StartPiiEntitiesDetectionJobRequest	withLanguageCode(java.lang.String languageCode) The language of the input documents.
StartPiiEntitiesDetectionJobRequest	withMode(PiiEntitiesDetectionMode mode) Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
StartPiiEntitiesDetectionJobRequest	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.
StartPiiEntitiesDetectionJobRequest	withOutputDataConfig(OutputDataConfig outputDataConfig) Provides configuration parameters for the output of PII entity detection jobs.
StartPiiEntitiesDetectionJobRequest	withRedactionConfig(RedactionConfig redactionConfig) Provides configuration parameters for PII entity redaction.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartPiiEntitiesDetectionJobRequest

public StartPiiEntitiesDetectionJobRequest()

Method Detail

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 StartPiiEntitiesDetectionJobRequest 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 OutputDataConfig getOutputDataConfig()

Provides configuration parameters for the output of PII entity detection jobs.

Returns:

Provides configuration parameters for the output of PII entity detection jobs.

setOutputDataConfig

public void setOutputDataConfig(OutputDataConfig outputDataConfig)

Provides configuration parameters for the output of PII entity detection jobs.

Parameters:

outputDataConfig -

Provides configuration parameters for the output of PII entity detection jobs.

withOutputDataConfig

public StartPiiEntitiesDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)

Provides configuration parameters for the output of PII entity detection jobs.

Returns a reference to this object so that method calls can be chained together.

Parameters:

outputDataConfig -

Provides configuration parameters for the output of PII entity detection jobs.

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 StartPiiEntitiesDetectionJobRequest 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 StartPiiEntitiesDetectionJobRequest 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

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 StartPiiEntitiesDetectionJobRequest 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.

getDataAccessRoleArn

public java.lang.String getDataAccessRoleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants 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) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

setDataAccessRoleArn

public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants 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) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

withDataAccessRoleArn

public StartPiiEntitiesDetectionJobRequest withDataAccessRoleArn(java.lang.String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants 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) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Returns:

A reference to this updated object so that method calls can be chained together.

getJobName

public java.lang.String getJobName()

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Returns:

The identifier of the job.

setJobName

public void setJobName(java.lang.String jobName)

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

jobName -

The identifier of the job.

withJobName

public StartPiiEntitiesDetectionJobRequest withJobName(java.lang.String jobName)

The identifier of the 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 identifier of the job.

Returns:

A reference to this updated object so that method calls can be chained together.

getLanguageCode

public java.lang.String getLanguageCode()

The language of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Returns:

The language of the input documents.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

The language of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language of the input documents.

See Also:

LanguageCode

withLanguageCode

public StartPiiEntitiesDetectionJobRequest withLanguageCode(java.lang.String languageCode)

The language 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 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 of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language of the input documents.

See Also:

LanguageCode

withLanguageCode

public StartPiiEntitiesDetectionJobRequest withLanguageCode(LanguageCode languageCode)

The language 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 of the input documents.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

getClientRequestToken

public java.lang.String getClientRequestToken()

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

Returns:

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

setClientRequestToken

public void setClientRequestToken(java.lang.String clientRequestToken)

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

Parameters:

clientRequestToken -

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

withClientRequestToken

public StartPiiEntitiesDetectionJobRequest withClientRequestToken(java.lang.String clientRequestToken)

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

Parameters:

clientRequestToken -

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

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