com.amazonaws.services.comprehend.model.StartPiiEntitiesDetectionJobRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-comprehend Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.comprehend.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartPiiEntitiesDetectionJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The input properties for a PII entities detection job.
*
*/
private InputDataConfig inputDataConfig;
/**
*
* Provides configuration parameters for the output of PII entity detection jobs.
*
*/
private OutputDataConfig outputDataConfig;
/**
*
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are
* redacted.
*
*/
private String mode;
/**
*
* 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.
*
*/
private RedactionConfig redactionConfig;
/**
*
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
*
*/
private String dataAccessRoleArn;
/**
*
* The identifier of the job.
*
*/
private String jobName;
/**
*
* The language of the input documents. Currently, English is the only valid language.
*
*/
private String languageCode;
/**
*
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
*
*/
private String clientRequestToken;
/**
*
* 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.
*
*/
private java.util.List tags;
/**
*
* The input properties for a PII entities detection job.
*
*
* @param inputDataConfig
* The input properties for a PII entities detection job.
*/
public void setInputDataConfig(InputDataConfig inputDataConfig) {
this.inputDataConfig = inputDataConfig;
}
/**
*
* The input properties for a PII entities detection job.
*
*
* @return The input properties for a PII entities detection job.
*/
public InputDataConfig getInputDataConfig() {
return this.inputDataConfig;
}
/**
*
* The input properties for a PII entities detection job.
*
*
* @param inputDataConfig
* The input properties for a PII entities detection job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withInputDataConfig(InputDataConfig inputDataConfig) {
setInputDataConfig(inputDataConfig);
return this;
}
/**
*
* Provides configuration parameters for the output of PII entity detection jobs.
*
*
* @param outputDataConfig
* Provides configuration parameters for the output of PII entity detection jobs.
*/
public void setOutputDataConfig(OutputDataConfig outputDataConfig) {
this.outputDataConfig = outputDataConfig;
}
/**
*
* Provides configuration parameters for the output of PII entity detection jobs.
*
*
* @return Provides configuration parameters for the output of PII entity detection jobs.
*/
public OutputDataConfig getOutputDataConfig() {
return this.outputDataConfig;
}
/**
*
* Provides configuration parameters for the output of PII entity detection jobs.
*
*
* @param outputDataConfig
* Provides configuration parameters for the output of PII entity detection jobs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig) {
setOutputDataConfig(outputDataConfig);
return this;
}
/**
*
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are
* redacted.
*
*
* @param mode
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII
* entities are redacted.
* @see PiiEntitiesDetectionMode
*/
public void setMode(String mode) {
this.mode = mode;
}
/**
*
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are
* redacted.
*
*
* @return Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII
* entities are redacted.
* @see PiiEntitiesDetectionMode
*/
public String getMode() {
return this.mode;
}
/**
*
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are
* redacted.
*
*
* @param mode
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII
* entities are redacted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PiiEntitiesDetectionMode
*/
public StartPiiEntitiesDetectionJobRequest withMode(String mode) {
setMode(mode);
return this;
}
/**
*
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are
* redacted.
*
*
* @param mode
* Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII
* entities are redacted.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PiiEntitiesDetectionMode
*/
public StartPiiEntitiesDetectionJobRequest withMode(PiiEntitiesDetectionMode mode) {
this.mode = mode.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setRedactionConfig(RedactionConfig redactionConfig) {
this.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.
*
*
* @return 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.
*/
public RedactionConfig getRedactionConfig() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withRedactionConfig(RedactionConfig redactionConfig) {
setRedactionConfig(redactionConfig);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
*
*
* @param dataAccessRoleArn
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input
* data.
*/
public void setDataAccessRoleArn(String dataAccessRoleArn) {
this.dataAccessRoleArn = dataAccessRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input
* data.
*/
public String getDataAccessRoleArn() {
return this.dataAccessRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
*
*
* @param dataAccessRoleArn
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input
* data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withDataAccessRoleArn(String dataAccessRoleArn) {
setDataAccessRoleArn(dataAccessRoleArn);
return this;
}
/**
*
* The identifier of the job.
*
*
* @param jobName
* The identifier of the job.
*/
public void setJobName(String jobName) {
this.jobName = jobName;
}
/**
*
* The identifier of the job.
*
*
* @return The identifier of the job.
*/
public String getJobName() {
return this.jobName;
}
/**
*
* The identifier of the job.
*
*
* @param jobName
* The identifier of the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withJobName(String jobName) {
setJobName(jobName);
return this;
}
/**
*
* The language of the input documents. Currently, English is the only valid language.
*
*
* @param languageCode
* The language of the input documents. Currently, English is the only valid language.
* @see LanguageCode
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
*
* The language of the input documents. Currently, English is the only valid language.
*
*
* @return The language of the input documents. Currently, English is the only valid language.
* @see LanguageCode
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
*
* The language of the input documents. Currently, English is the only valid language.
*
*
* @param languageCode
* The language of the input documents. Currently, English is the only valid language.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public StartPiiEntitiesDetectionJobRequest withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
*
* The language of the input documents. Currently, English is the only valid language.
*
*
* @param languageCode
* The language of the input documents. Currently, English is the only valid language.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public StartPiiEntitiesDetectionJobRequest withLanguageCode(LanguageCode languageCode) {
this.languageCode = languageCode.toString();
return this;
}
/**
*
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
*
*
* @param clientRequestToken
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend
* generates one.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
*
*
* @return A unique identifier for the request. If you don't set the client request token, Amazon Comprehend
* generates one.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
*
*
* @param clientRequestToken
* A unique identifier for the request. If you don't set the client request token, Amazon Comprehend
* generates one.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getTags() {
return 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.
*
*
* @param 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.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(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
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartPiiEntitiesDetectionJobRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInputDataConfig() != null)
sb.append("InputDataConfig: ").append(getInputDataConfig()).append(",");
if (getOutputDataConfig() != null)
sb.append("OutputDataConfig: ").append(getOutputDataConfig()).append(",");
if (getMode() != null)
sb.append("Mode: ").append(getMode()).append(",");
if (getRedactionConfig() != null)
sb.append("RedactionConfig: ").append(getRedactionConfig()).append(",");
if (getDataAccessRoleArn() != null)
sb.append("DataAccessRoleArn: ").append(getDataAccessRoleArn()).append(",");
if (getJobName() != null)
sb.append("JobName: ").append(getJobName()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartPiiEntitiesDetectionJobRequest == false)
return false;
StartPiiEntitiesDetectionJobRequest other = (StartPiiEntitiesDetectionJobRequest) obj;
if (other.getInputDataConfig() == null ^ this.getInputDataConfig() == null)
return false;
if (other.getInputDataConfig() != null && other.getInputDataConfig().equals(this.getInputDataConfig()) == false)
return false;
if (other.getOutputDataConfig() == null ^ this.getOutputDataConfig() == null)
return false;
if (other.getOutputDataConfig() != null && other.getOutputDataConfig().equals(this.getOutputDataConfig()) == false)
return false;
if (other.getMode() == null ^ this.getMode() == null)
return false;
if (other.getMode() != null && other.getMode().equals(this.getMode()) == false)
return false;
if (other.getRedactionConfig() == null ^ this.getRedactionConfig() == null)
return false;
if (other.getRedactionConfig() != null && other.getRedactionConfig().equals(this.getRedactionConfig()) == false)
return false;
if (other.getDataAccessRoleArn() == null ^ this.getDataAccessRoleArn() == null)
return false;
if (other.getDataAccessRoleArn() != null && other.getDataAccessRoleArn().equals(this.getDataAccessRoleArn()) == false)
return false;
if (other.getJobName() == null ^ this.getJobName() == null)
return false;
if (other.getJobName() != null && other.getJobName().equals(this.getJobName()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInputDataConfig() == null) ? 0 : getInputDataConfig().hashCode());
hashCode = prime * hashCode + ((getOutputDataConfig() == null) ? 0 : getOutputDataConfig().hashCode());
hashCode = prime * hashCode + ((getMode() == null) ? 0 : getMode().hashCode());
hashCode = prime * hashCode + ((getRedactionConfig() == null) ? 0 : getRedactionConfig().hashCode());
hashCode = prime * hashCode + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode());
hashCode = prime * hashCode + ((getJobName() == null) ? 0 : getJobName().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public StartPiiEntitiesDetectionJobRequest clone() {
return (StartPiiEntitiesDetectionJobRequest) super.clone();
}
}