/* * Copyright 2010-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; /** *

* Provides configuration parameters for the output of inference jobs. *

*

*/ public class OutputDataConfig implements Serializable { /** *

* When you use the OutputDataConfig object with asynchronous * operations, you specify the Amazon S3 location where you want to write * the output data. The URI must be in the same Region as the API endpoint * that you are calling. The location is used as the prefix for the actual * location of the output file. *

*

* When the topic detection job is finished, the service creates an output * file in a directory specific to the job. The S3Uri field * contains the location of the output file, called * output.tar.gz. It is a compressed archive that contains the * ouput of the operation. *

*

* For a PII entity detection job, the output file is plain text, not a * compressed archive. The output file name is the same as the input file, * with .out appended at the end. *

*

* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
*/ private String s3Uri; /** *

* ID for the Amazon Web Services Key Management Service (KMS) key that * Amazon Comprehend uses to encrypt the output results from an analysis * job. The KmsKeyId can be one of the following formats: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
*/ private String kmsKeyId; /** *

* When you use the OutputDataConfig object with asynchronous * operations, you specify the Amazon S3 location where you want to write * the output data. The URI must be in the same Region as the API endpoint * that you are calling. The location is used as the prefix for the actual * location of the output file. *

*

* When the topic detection job is finished, the service creates an output * file in a directory specific to the job. The S3Uri field * contains the location of the output file, called * output.tar.gz. It is a compressed archive that contains the * ouput of the operation. *

*

* For a PII entity detection job, the output file is plain text, not a * compressed archive. The output file name is the same as the input file, * with .out appended at the end. *

*

* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
* * @return

* When you use the OutputDataConfig object with * asynchronous operations, you specify the Amazon S3 location where * you want to write the output data. The URI must be in the same * Region as the API endpoint that you are calling. The location is * used as the prefix for the actual location of the output file. *

*

* When the topic detection job is finished, the service creates an * output file in a directory specific to the job. The * S3Uri field contains the location of the output * file, called output.tar.gz. It is a compressed * archive that contains the ouput of the operation. *

*

* For a PII entity detection job, the output file is plain text, * not a compressed archive. The output file name is the same as the * input file, with .out appended at the end. *

*/ public String getS3Uri() { return s3Uri; } /** *

* When you use the OutputDataConfig object with asynchronous * operations, you specify the Amazon S3 location where you want to write * the output data. The URI must be in the same Region as the API endpoint * that you are calling. The location is used as the prefix for the actual * location of the output file. *

*

* When the topic detection job is finished, the service creates an output * file in a directory specific to the job. The S3Uri field * contains the location of the output file, called * output.tar.gz. It is a compressed archive that contains the * ouput of the operation. *

*

* For a PII entity detection job, the output file is plain text, not a * compressed archive. The output file name is the same as the input file, * with .out appended at the end. *

*

* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
* * @param s3Uri

* When you use the OutputDataConfig object with * asynchronous operations, you specify the Amazon S3 location * where you want to write the output data. The URI must be in * the same Region as the API endpoint that you are calling. The * location is used as the prefix for the actual location of the * output file. *

*

* When the topic detection job is finished, the service creates * an output file in a directory specific to the job. The * S3Uri field contains the location of the output * file, called output.tar.gz. It is a compressed * archive that contains the ouput of the operation. *

*

* For a PII entity detection job, the output file is plain text, * not a compressed archive. The output file name is the same as * the input file, with .out appended at the end. *

*/ public void setS3Uri(String s3Uri) { this.s3Uri = s3Uri; } /** *

* When you use the OutputDataConfig object with asynchronous * operations, you specify the Amazon S3 location where you want to write * the output data. The URI must be in the same Region as the API endpoint * that you are calling. The location is used as the prefix for the actual * location of the output file. *

*

* When the topic detection job is finished, the service creates an output * file in a directory specific to the job. The S3Uri field * contains the location of the output file, called * output.tar.gz. It is a compressed archive that contains the * ouput of the operation. *

*

* For a PII entity detection job, the output file is plain text, not a * compressed archive. The output file name is the same as the input file, * with .out appended at the end. *

*

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

* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
* * @param s3Uri

* When you use the OutputDataConfig object with * asynchronous operations, you specify the Amazon S3 location * where you want to write the output data. The URI must be in * the same Region as the API endpoint that you are calling. The * location is used as the prefix for the actual location of the * output file. *

*

* When the topic detection job is finished, the service creates * an output file in a directory specific to the job. The * S3Uri field contains the location of the output * file, called output.tar.gz. It is a compressed * archive that contains the ouput of the operation. *

*

* For a PII entity detection job, the output file is plain text, * not a compressed archive. The output file name is the same as * the input file, with .out appended at the end. *

* @return A reference to this updated object so that method calls can be * chained together. */ public OutputDataConfig withS3Uri(String s3Uri) { this.s3Uri = s3Uri; return this; } /** *

* ID for the Amazon Web Services Key Management Service (KMS) key that * Amazon Comprehend uses to encrypt the output results from an analysis * job. The KmsKeyId can be one of the following formats: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @return

* ID for the Amazon Web Services Key Management Service (KMS) key * that Amazon Comprehend uses to encrypt the output results from an * analysis job. The KmsKeyId can be one of the following formats: *

* */ public String getKmsKeyId() { return kmsKeyId; } /** *

* ID for the Amazon Web Services Key Management Service (KMS) key that * Amazon Comprehend uses to encrypt the output results from an analysis * job. The KmsKeyId can be one of the following formats: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @param kmsKeyId

* ID for the Amazon Web Services Key Management Service (KMS) * key that Amazon Comprehend uses to encrypt the output results * from an analysis job. The KmsKeyId can be one of the following * formats: *

* */ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** *

* ID for the Amazon Web Services Key Management Service (KMS) key that * Amazon Comprehend uses to encrypt the output results from an analysis * job. The KmsKeyId can be one of the following formats: *

* *

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

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @param kmsKeyId

* ID for the Amazon Web Services Key Management Service (KMS) * key that Amazon Comprehend uses to encrypt the output results * from an analysis job. The KmsKeyId can be one of the following * formats: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public OutputDataConfig withKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getS3Uri() != null) sb.append("S3Uri: " + getS3Uri() + ","); if (getKmsKeyId() != null) sb.append("KmsKeyId: " + getKmsKeyId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode()); hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof OutputDataConfig == false) return false; OutputDataConfig other = (OutputDataConfig) obj; if (other.getS3Uri() == null ^ this.getS3Uri() == null) return false; if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false) return false; if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null) return false; if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false) return false; return true; } }