com.amazonaws.services.comprehend.model

Class StartPiiEntitiesDetectionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.StartPiiEntitiesDetectionJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartPiiEntitiesDetectionJobRequest()

Method Summary

Modifier and Type	Method and Description
StartPiiEntitiesDetectionJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A unique identifier for the request.
String	getDataAccessRoleArn() The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
InputDataConfig	getInputDataConfig() The input properties for a PII entities detection job.
String	getJobName() The identifier of the job.
String	getLanguageCode() The language of the input documents.
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.
List<Tag>	getTags() Tags to associate with the PII entities detection job.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) A unique identifier for the request.
void	setDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the 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(String jobName) The identifier of the job.
void	setLanguageCode(String languageCode) The language of the input documents.
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(OutputDataConfig outputDataConfig) Provides configuration parameters for the output of PII entity detection jobs.
void	setRedactionConfig(RedactionConfig redactionConfig) Provides configuration parameters for PII entity redaction.
void	setTags(Collection<Tag> tags) Tags to associate with the PII entities detection job.
String	toString() Returns a string representation of this object.
StartPiiEntitiesDetectionJobRequest	withClientRequestToken(String clientRequestToken) A unique identifier for the request.
StartPiiEntitiesDetectionJobRequest	withDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the 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(String jobName) The identifier of the job.
StartPiiEntitiesDetectionJobRequest	withLanguageCode(LanguageCode languageCode) The language of the input documents.
StartPiiEntitiesDetectionJobRequest	withLanguageCode(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(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.
StartPiiEntitiesDetectionJobRequest	withTags(Collection<Tag> tags) Tags to associate with the PII entities detection job.
StartPiiEntitiesDetectionJobRequest	withTags(Tag... tags) Tags to associate with the PII entities detection job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartPiiEntitiesDetectionJobRequest

public StartPiiEntitiesDetectionJobRequest()

Method Detail

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

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.

withOutputDataConfig

public StartPiiEntitiesDetectionJobRequest withOutputDataConfig(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.

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

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

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.

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

setJobName

public void setJobName(String jobName)

The identifier of the job.

Parameters:

jobName - The identifier of the job.

getJobName

public String getJobName()

The identifier of the job.

Returns:

The identifier of the job.

withJobName

public StartPiiEntitiesDetectionJobRequest withJobName(String jobName)

The identifier of the job.

Parameters:

jobName - The identifier of the job.

Returns:

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

setLanguageCode

public void setLanguageCode(String languageCode)

The language of the input documents. Enter the language code for English (en) or Spanish (es).

Parameters:

languageCode - The language of the input documents. Enter the language code for English (en) or Spanish (es).

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language of the input documents. Enter the language code for English (en) or Spanish (es).

Returns:

The language of the input documents. Enter the language code for English (en) or Spanish (es).

See Also:

LanguageCode

withLanguageCode

public StartPiiEntitiesDetectionJobRequest withLanguageCode(String languageCode)

The language of the input documents. Enter the language code for English (en) or Spanish (es).

Parameters:

languageCode - The language of the input documents. Enter the language code for English (en) or Spanish (es).

Returns:

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

See Also:

LanguageCode

withLanguageCode

public StartPiiEntitiesDetectionJobRequest withLanguageCode(LanguageCode languageCode)

The language of the input documents. Enter the language code for English (en) or Spanish (es).

Parameters:

languageCode - The language of the input documents. Enter the language code for English (en) or Spanish (es).

Returns:

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

See Also:

LanguageCode

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

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

Parameters:

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

getClientRequestToken

public String getClientRequestToken()

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

Returns:

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

withClientRequestToken

public StartPiiEntitiesDetectionJobRequest withClientRequestToken(String clientRequestToken)

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

Parameters:

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

Returns:

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

getTags

public List<Tag> getTags()

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

setTags

public void setTags(Collection<Tag> tags)

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

withTags

public StartPiiEntitiesDetectionJobRequest withTags(Tag... tags)

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

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

withTags

public StartPiiEntitiesDetectionJobRequest withTags(Collection<Tag> tags)

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

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

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 StartPiiEntitiesDetectionJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()