/* * 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 configuration parameters for the output of inference jobs. *

*

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class OutputDataConfig implements Serializable, Cloneable, StructuredPojo { /** *

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

*/ 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: *

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

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

* * @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 this.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. *

* * @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 Returns a reference to this object so that method calls can be chained together. */ public OutputDataConfig withS3Uri(String s3Uri) { setS3Uri(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: *

* * * @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:

*