/* * 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.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides information about a PII entities detection job. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PiiEntitiesDetectionJobProperties implements Serializable, Cloneable, StructuredPojo { /** ** The identifier assigned to the PII entities detection job. *
*/ private String jobId; /** ** 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
*
* The name that you assigned the PII entities detection job. *
*/ private String jobName; /** *
* The current status of the PII entities detection job. If the status is FAILED
, the
* Message
field shows the reason for the failure.
*
* A description of the status of a job. *
*/ private String message; /** ** The time that the PII entities detection job was submitted for processing. *
*/ private java.util.Date submitTime; /** ** The time that the PII entities detection job completed. *
*/ private java.util.Date endTime; /** ** The input properties for a PII entities detection job. *
*/ private InputDataConfig inputDataConfig; /** ** The output data configuration that you supplied when you created the PII entities detection job. *
*/ private PiiOutputDataConfig outputDataConfig; /** ** 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.
*
* The language code of the input documents *
*/ private String languageCode; /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. *
*/ private String dataAccessRoleArn; /** ** Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are * redacted. *
*/ private String mode; /** ** The identifier assigned to the PII entities detection job. *
* * @param jobId * The identifier assigned to the PII entities detection job. */ public void setJobId(String jobId) { this.jobId = jobId; } /** ** The identifier assigned to the PII entities detection job. *
* * @return The identifier assigned to the PII entities detection job. */ public String getJobId() { return this.jobId; } /** ** The identifier assigned to the PII entities detection job. *
* * @param jobId * The identifier assigned to the PII entities detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public PiiEntitiesDetectionJobProperties withJobId(String jobId) { setJobId(jobId); return this; } /** ** 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
*
* 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
*/
public void setJobArn(String jobArn) {
this.jobArn = 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
*
* 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
*/
public String getJobArn() {
return this.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
*
* 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PiiEntitiesDetectionJobProperties withJobArn(String jobArn) {
setJobArn(jobArn);
return this;
}
/**
*
* The name that you assigned the PII entities detection job. *
* * @param jobName * The name that you assigned the PII entities detection job. */ public void setJobName(String jobName) { this.jobName = jobName; } /** ** The name that you assigned the PII entities detection job. *
* * @return The name that you assigned the PII entities detection job. */ public String getJobName() { return this.jobName; } /** ** The name that you assigned the PII entities detection job. *
* * @param jobName * The name that you assigned the PII entities detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public PiiEntitiesDetectionJobProperties withJobName(String jobName) { setJobName(jobName); return this; } /** *
* The current status of the PII entities detection job. If the status is FAILED
, the
* Message
field shows the reason for the failure.
*
FAILED
, the
* Message
field shows the reason for the failure.
* @see JobStatus
*/
public void setJobStatus(String jobStatus) {
this.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.
*
FAILED
, the
* Message
field shows the reason for the failure.
* @see JobStatus
*/
public String getJobStatus() {
return this.jobStatus;
}
/**
*
* The current status of the PII entities detection job. If the status is FAILED
, the
* Message
field shows the reason for the failure.
*
FAILED
, the
* Message
field shows the reason for the failure.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public PiiEntitiesDetectionJobProperties withJobStatus(String jobStatus) {
setJobStatus(jobStatus);
return this;
}
/**
*
* The current status of the PII entities detection job. If the status is FAILED
, the
* Message
field shows the reason for the failure.
*
FAILED
, the
* Message
field shows the reason for the failure.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public PiiEntitiesDetectionJobProperties withJobStatus(JobStatus jobStatus) {
this.jobStatus = jobStatus.toString();
return this;
}
/**
* * A description of the status of a job. *
* * @param message * A description of the status of a job. */ public void setMessage(String message) { this.message = message; } /** ** A description of the status of a job. *
* * @return A description of the status of a job. */ public String getMessage() { return this.message; } /** ** A description of the status of a job. *
* * @param message * A description of the status of a job. * @return Returns a reference to this object so that method calls can be chained together. */ public PiiEntitiesDetectionJobProperties withMessage(String message) { setMessage(message); return this; } /** ** The time that the PII entities detection job was submitted for processing. *
* * @param submitTime * The time that the PII entities detection job was submitted for processing. */ public void setSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; } /** ** The time that the PII entities detection job was submitted for processing. *
* * @return The time that the PII entities detection job was submitted for processing. */ public java.util.Date getSubmitTime() { return this.submitTime; } /** ** The time that the PII entities detection job was submitted for processing. *
* * @param submitTime * The time that the PII entities detection job was submitted for processing. * @return Returns a reference to this object so that method calls can be chained together. */ public PiiEntitiesDetectionJobProperties withSubmitTime(java.util.Date submitTime) { setSubmitTime(submitTime); return this; } /** ** The time that the PII entities detection job completed. *
* * @param endTime * The time that the PII entities detection job completed. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The time that the PII entities detection job completed. *
* * @return The time that the PII entities detection job completed. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The time that the PII entities detection job completed. *
* * @param endTime * The time that the PII entities detection job completed. * @return Returns a reference to this object so that method calls can be chained together. */ public PiiEntitiesDetectionJobProperties withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** ** 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 PiiEntitiesDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** ** The output data configuration that you supplied when you created the PII entities detection job. *
* * @param outputDataConfig * The output data configuration that you supplied when you created the PII entities detection job. */ public void setOutputDataConfig(PiiOutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** ** The output data configuration that you supplied when you created the PII entities detection job. *
* * @return The output data configuration that you supplied when you created the PII entities detection job. */ public PiiOutputDataConfig getOutputDataConfig() { return this.outputDataConfig; } /** ** The output data configuration that you supplied when you created the PII entities detection job. *
* * @param outputDataConfig * The output data configuration that you supplied when you created the PII entities detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public PiiEntitiesDetectionJobProperties withOutputDataConfig(PiiOutputDataConfig outputDataConfig) { setOutputDataConfig(outputDataConfig); 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.
*
* 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.
*
* 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.
*
* 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 PiiEntitiesDetectionJobProperties withRedactionConfig(RedactionConfig redactionConfig) {
setRedactionConfig(redactionConfig);
return this;
}
/**
*
* The language code of the input documents *
* * @param languageCode * The language code of the input documents * @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** ** The language code of the input documents *
* * @return The language code of the input documents * @see LanguageCode */ public String getLanguageCode() { return this.languageCode; } /** ** The language code of the input documents *
* * @param languageCode * The language code of the input documents * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public PiiEntitiesDetectionJobProperties withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** ** The language code of the input documents *
* * @param languageCode * The language code of the input documents * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public PiiEntitiesDetectionJobProperties withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); 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 PiiEntitiesDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(dataAccessRoleArn); 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 PiiEntitiesDetectionJobProperties 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 PiiEntitiesDetectionJobProperties withMode(PiiEntitiesDetectionMode mode) { this.mode = mode.toString(); 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 (getJobId() != null) sb.append("JobId: ").append(getJobId()).append(","); if (getJobArn() != null) sb.append("JobArn: ").append(getJobArn()).append(","); if (getJobName() != null) sb.append("JobName: ").append(getJobName()).append(","); if (getJobStatus() != null) sb.append("JobStatus: ").append(getJobStatus()).append(","); if (getMessage() != null) sb.append("Message: ").append(getMessage()).append(","); if (getSubmitTime() != null) sb.append("SubmitTime: ").append(getSubmitTime()).append(","); if (getEndTime() != null) sb.append("EndTime: ").append(getEndTime()).append(","); if (getInputDataConfig() != null) sb.append("InputDataConfig: ").append(getInputDataConfig()).append(","); if (getOutputDataConfig() != null) sb.append("OutputDataConfig: ").append(getOutputDataConfig()).append(","); if (getRedactionConfig() != null) sb.append("RedactionConfig: ").append(getRedactionConfig()).append(","); if (getLanguageCode() != null) sb.append("LanguageCode: ").append(getLanguageCode()).append(","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: ").append(getDataAccessRoleArn()).append(","); if (getMode() != null) sb.append("Mode: ").append(getMode()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PiiEntitiesDetectionJobProperties == false) return false; PiiEntitiesDetectionJobProperties other = (PiiEntitiesDetectionJobProperties) obj; if (other.getJobId() == null ^ this.getJobId() == null) return false; if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false) return false; if (other.getJobArn() == null ^ this.getJobArn() == null) return false; if (other.getJobArn() != null && other.getJobArn().equals(this.getJobArn()) == 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.getJobStatus() == null ^ this.getJobStatus() == null) return false; if (other.getJobStatus() != null && other.getJobStatus().equals(this.getJobStatus()) == false) return false; if (other.getMessage() == null ^ this.getMessage() == null) return false; if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false) return false; if (other.getSubmitTime() == null ^ this.getSubmitTime() == null) return false; if (other.getSubmitTime() != null && other.getSubmitTime().equals(this.getSubmitTime()) == false) return false; if (other.getEndTime() == null ^ this.getEndTime() == null) return false; if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false) return false; 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.getRedactionConfig() == null ^ this.getRedactionConfig() == null) return false; if (other.getRedactionConfig() != null && other.getRedactionConfig().equals(this.getRedactionConfig()) == 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.getDataAccessRoleArn() == null ^ this.getDataAccessRoleArn() == null) return false; if (other.getDataAccessRoleArn() != null && other.getDataAccessRoleArn().equals(this.getDataAccessRoleArn()) == false) return false; if (other.getMode() == null ^ this.getMode() == null) return false; if (other.getMode() != null && other.getMode().equals(this.getMode()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode()); hashCode = prime * hashCode + ((getJobArn() == null) ? 0 : getJobArn().hashCode()); hashCode = prime * hashCode + ((getJobName() == null) ? 0 : getJobName().hashCode()); hashCode = prime * hashCode + ((getJobStatus() == null) ? 0 : getJobStatus().hashCode()); hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode()); hashCode = prime * hashCode + ((getSubmitTime() == null) ? 0 : getSubmitTime().hashCode()); hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); hashCode = prime * hashCode + ((getInputDataConfig() == null) ? 0 : getInputDataConfig().hashCode()); hashCode = prime * hashCode + ((getOutputDataConfig() == null) ? 0 : getOutputDataConfig().hashCode()); hashCode = prime * hashCode + ((getRedactionConfig() == null) ? 0 : getRedactionConfig().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode()); hashCode = prime * hashCode + ((getMode() == null) ? 0 : getMode().hashCode()); return hashCode; } @Override public PiiEntitiesDetectionJobProperties clone() { try { return (PiiEntitiesDetectionJobProperties) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.comprehend.model.transform.PiiEntitiesDetectionJobPropertiesMarshaller.getInstance().marshall(this, protocolMarshaller); } }