/* * 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 StartDocumentClassificationJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The identifier of the job. *

*/ private String jobName; /** *

* The Amazon Resource Name (ARN) of the document classifier to use to process the job. *

*/ private String documentClassifierArn; /** *

* Specifies the format and location of the input data for the job. *

*/ private InputDataConfig inputDataConfig; /** *

* Specifies where to send the output files. *

*/ private OutputDataConfig outputDataConfig; /** *

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. *

*/ private String dataAccessRoleArn; /** *

* A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one. *

*/ private String clientRequestToken; /** *

* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on * the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can * be either of the following formats: *

* */ private String volumeKmsKeyId; /** *

* Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are * using for your document classification job. For more information, see Amazon VPC. *

*/ private VpcConfig vpcConfig; /** *

* Tags to associate with the document classification 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 Amazon Resource Number (ARN) of the flywheel associated with the model to use. *

*/ private String flywheelArn; /** *

* 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 StartDocumentClassificationJobRequest withJobName(String jobName) { setJobName(jobName); return this; } /** *

* The Amazon Resource Name (ARN) of the document classifier to use to process the job. *

* * @param documentClassifierArn * The Amazon Resource Name (ARN) of the document classifier to use to process the job. */ public void setDocumentClassifierArn(String documentClassifierArn) { this.documentClassifierArn = documentClassifierArn; } /** *

* The Amazon Resource Name (ARN) of the document classifier to use to process the job. *

* * @return The Amazon Resource Name (ARN) of the document classifier to use to process the job. */ public String getDocumentClassifierArn() { return this.documentClassifierArn; } /** *

* The Amazon Resource Name (ARN) of the document classifier to use to process the job. *

* * @param documentClassifierArn * The Amazon Resource Name (ARN) of the document classifier to use to process the job. * @return Returns a reference to this object so that method calls can be chained together. */ public StartDocumentClassificationJobRequest withDocumentClassifierArn(String documentClassifierArn) { setDocumentClassifierArn(documentClassifierArn); return this; } /** *

* Specifies the format and location of the input data for the job. *

* * @param inputDataConfig * Specifies the format and location of the input data for the job. */ public void setInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; } /** *

* Specifies the format and location of the input data for the job. *

* * @return Specifies the format and location of the input data for the job. */ public InputDataConfig getInputDataConfig() { return this.inputDataConfig; } /** *

* Specifies the format and location of the input data for the job. *

* * @param inputDataConfig * Specifies the format and location of the input data for the job. * @return Returns a reference to this object so that method calls can be chained together. */ public StartDocumentClassificationJobRequest withInputDataConfig(InputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** *

* Specifies where to send the output files. *

* * @param outputDataConfig * Specifies where to send the output files. */ public void setOutputDataConfig(OutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** *

* Specifies where to send the output files. *

* * @return Specifies where to send the output files. */ public OutputDataConfig getOutputDataConfig() { return this.outputDataConfig; } /** *

* Specifies where to send the output files. *

* * @param outputDataConfig * Specifies where to send the output files. * @return Returns a reference to this object so that method calls can be chained together. */ public StartDocumentClassificationJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig) { setOutputDataConfig(outputDataConfig); 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 StartDocumentClassificationJobRequest withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(dataAccessRoleArn); return this; } /** *

* A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one. *

* * @param clientRequestToken * A unique identifier for the request. If you do not 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 do not set the client request token, Amazon Comprehend generates one. *

* * @return A unique identifier for the request. If you do not set the client request token, Amazon Comprehend * generates one. */ public String getClientRequestToken() { return this.clientRequestToken; } /** *

* A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one. *

* * @param clientRequestToken * A unique identifier for the request. If you do not 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 StartDocumentClassificationJobRequest withClientRequestToken(String clientRequestToken) { setClientRequestToken(clientRequestToken); return this; } /** *

* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on * the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can * be either of the following formats: *

* * * @param volumeKmsKeyId * ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt * data on the storage volume attached to the ML compute instance(s) that process the analysis job. The * VolumeKmsKeyId can be either of the following formats:

*