/* * 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; import com.amazonaws.AmazonWebServiceRequest; /** *

* Starts an asynchronous topic detection job. Use the * DescribeTopicDetectionJob operation to track the status of a * job. *

*/ public class StartTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable { /** *

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

*/ private InputDataConfig inputDataConfig; /** *

* Specifies where to send the output files. The output is a compressed * archive with two files, topic-terms.csv that lists the terms * associated with each topic, and doc-topics.csv that lists * the documents associated with each topic *

*/ private OutputDataConfig outputDataConfig; /** *

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. For more information, see Role-based permissions. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
*/ private String dataAccessRoleArn; /** *

* The identifier of the job. *

*

* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*/ private String jobName; /** *

* The number of topics to detect. *

*

* Constraints:
* Range: 1 - 100
*/ private Integer numberOfTopics; /** *

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

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-]+$
*/ 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: *

* *

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

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

*/ private VpcConfig vpcConfig; /** *

* Tags to associate with the topics 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; /** *

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

*/ public void setInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; } /** *

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

*

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

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartTopicsDetectionJobRequest withInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; return this; } /** *

* Specifies where to send the output files. The output is a compressed * archive with two files, topic-terms.csv that lists the terms * associated with each topic, and doc-topics.csv that lists * the documents associated with each topic *

* * @return

* Specifies where to send the output files. The output is a * compressed archive with two files, topic-terms.csv * that lists the terms associated with each topic, and * doc-topics.csv that lists the documents associated * with each topic *

*/ public OutputDataConfig getOutputDataConfig() { return outputDataConfig; } /** *

* Specifies where to send the output files. The output is a compressed * archive with two files, topic-terms.csv that lists the terms * associated with each topic, and doc-topics.csv that lists * the documents associated with each topic *

* * @param outputDataConfig

* Specifies where to send the output files. The output is a * compressed archive with two files, * topic-terms.csv that lists the terms associated * with each topic, and doc-topics.csv that lists * the documents associated with each topic *

*/ public void setOutputDataConfig(OutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** *

* Specifies where to send the output files. The output is a compressed * archive with two files, topic-terms.csv that lists the terms * associated with each topic, and doc-topics.csv that lists * the documents associated with each topic *

*

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

* Specifies where to send the output files. The output is a * compressed archive with two files, * topic-terms.csv that lists the terms associated * with each topic, and doc-topics.csv that lists * the documents associated with each topic *

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

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. For more information, see Role-based permissions. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
* * @return

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. For more information, * see Role-based permissions. *

*/ public String getDataAccessRoleArn() { return dataAccessRoleArn; } /** *

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. For more information, see Role-based permissions. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
* * @param dataAccessRoleArn

* The Amazon Resource Name (ARN) of the IAM role that grants * Amazon Comprehend read access to your input data. For more * information, see Role-based permissions. *

*/ 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. For more information, see Role-based permissions. *

*

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

* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
* * @param dataAccessRoleArn

* The Amazon Resource Name (ARN) of the IAM role that grants * Amazon Comprehend read access to your input data. For more * information, see Role-based permissions. *

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

* The identifier of the job. *

*

* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
* * @return

* The identifier of the job. *

*/ public String getJobName() { return jobName; } /** *

* The identifier of the job. *

*

* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
* * @param jobName

* The identifier of the job. *

*/ public void setJobName(String jobName) { this.jobName = jobName; } /** *

* The identifier of the job. *

*

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

* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
* * @param jobName

* The identifier of the job. *

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

* The number of topics to detect. *

*

* Constraints:
* Range: 1 - 100
* * @return

* The number of topics to detect. *

*/ public Integer getNumberOfTopics() { return numberOfTopics; } /** *

* The number of topics to detect. *

*

* Constraints:
* Range: 1 - 100
* * @param numberOfTopics

* The number of topics to detect. *

*/ public void setNumberOfTopics(Integer numberOfTopics) { this.numberOfTopics = numberOfTopics; } /** *

* The number of topics to detect. *

*

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

* Constraints:
* Range: 1 - 100
* * @param numberOfTopics

* The number of topics to detect. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartTopicsDetectionJobRequest withNumberOfTopics(Integer numberOfTopics) { this.numberOfTopics = numberOfTopics; return this; } /** *

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

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-]+$
* * @return

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

*/ public String getClientRequestToken() { return clientRequestToken; } /** *

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

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-]+$
* * @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. *

*

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

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-]+$
* * @param clientRequestToken

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartTopicsDetectionJobRequest withClientRequestToken(String clientRequestToken) { this.clientRequestToken = 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: *

* *

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

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

* */ public String getVolumeKmsKeyId() { return 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: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @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: *

* */ public void setVolumeKmsKeyId(String volumeKmsKeyId) { this.volumeKmsKeyId = 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: *

* *

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

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @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: *

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

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

* * @return

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

*/ public VpcConfig getVpcConfig() { return vpcConfig; } /** *

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

* * @param vpcConfig

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

*/ public void setVpcConfig(VpcConfig vpcConfig) { this.vpcConfig = vpcConfig; } /** *

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

*

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

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartTopicsDetectionJobRequest withVpcConfig(VpcConfig vpcConfig) { this.vpcConfig = vpcConfig; return this; } /** *

* Tags to associate with the topics 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 topics 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 topics 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 topics 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 topics 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. *

*

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

* Tags to associate with the topics 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 A reference to this updated object so that method calls can be * chained together. */ public StartTopicsDetectionJobRequest withTags(Tag... tags) { if (getTags() == null) { this.tags = new java.util.ArrayList(tags.length); } for (Tag value : tags) { this.tags.add(value); } return this; } /** *

* Tags to associate with the topics 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. *

*

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

* Tags to associate with the topics 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 A reference to this updated object so that method calls can be * chained together. */ public StartTopicsDetectionJobRequest withTags(java.util.Collection tags) { setTags(tags); 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 (getInputDataConfig() != null) sb.append("InputDataConfig: " + getInputDataConfig() + ","); if (getOutputDataConfig() != null) sb.append("OutputDataConfig: " + getOutputDataConfig() + ","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: " + getDataAccessRoleArn() + ","); if (getJobName() != null) sb.append("JobName: " + getJobName() + ","); if (getNumberOfTopics() != null) sb.append("NumberOfTopics: " + getNumberOfTopics() + ","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken() + ","); if (getVolumeKmsKeyId() != null) sb.append("VolumeKmsKeyId: " + getVolumeKmsKeyId() + ","); if (getVpcConfig() != null) sb.append("VpcConfig: " + getVpcConfig() + ","); if (getTags() != null) sb.append("Tags: " + getTags()); sb.append("}"); return sb.toString(); } @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 + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode()); hashCode = prime * hashCode + ((getJobName() == null) ? 0 : getJobName().hashCode()); hashCode = prime * hashCode + ((getNumberOfTopics() == null) ? 0 : getNumberOfTopics().hashCode()); hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode()); hashCode = prime * hashCode + ((getVolumeKmsKeyId() == null) ? 0 : getVolumeKmsKeyId().hashCode()); hashCode = prime * hashCode + ((getVpcConfig() == null) ? 0 : getVpcConfig().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartTopicsDetectionJobRequest == false) return false; StartTopicsDetectionJobRequest other = (StartTopicsDetectionJobRequest) 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.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.getNumberOfTopics() == null ^ this.getNumberOfTopics() == null) return false; if (other.getNumberOfTopics() != null && other.getNumberOfTopics().equals(this.getNumberOfTopics()) == 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.getVolumeKmsKeyId() == null ^ this.getVolumeKmsKeyId() == null) return false; if (other.getVolumeKmsKeyId() != null && other.getVolumeKmsKeyId().equals(this.getVolumeKmsKeyId()) == false) return false; if (other.getVpcConfig() == null ^ this.getVpcConfig() == null) return false; if (other.getVpcConfig() != null && other.getVpcConfig().equals(this.getVpcConfig()) == 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; } }