/* * 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; public class StartDocumentClassificationJobResult implements Serializable { /** *

* The identifier generated for the job. To get the status of the job, use * this identifier with the DescribeDocumentClassificationJob * operation. *

*

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

* The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- * Z0-9-]{1,64} * /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0- * 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
*/ private String jobArn; /** *

* The status of the job: *

* *

* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, * STOP_REQUESTED, STOPPED */ private String jobStatus; /** *

* The ARN of the custom classification model. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document * -classifier * /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
*/ private String documentClassifierArn; /** *

* The identifier generated for the job. To get the status of the job, use * this identifier with the DescribeDocumentClassificationJob * operation. *

*

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

* The identifier generated for the job. To get the status of the * job, use this identifier with the * DescribeDocumentClassificationJob operation. *

*/ public String getJobId() { return jobId; } /** *

* The identifier generated for the job. To get the status of the job, use * this identifier with the DescribeDocumentClassificationJob * operation. *

*

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

* The identifier generated for the job. To get the status of the * job, use this identifier with the * DescribeDocumentClassificationJob operation. *

*/ public void setJobId(String jobId) { this.jobId = jobId; } /** *

* The identifier generated for the job. To get the status of the job, use * this identifier with the DescribeDocumentClassificationJob * operation. *

*

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

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

* The identifier generated for the job. To get the status of the * job, use this identifier with the * DescribeDocumentClassificationJob operation. *

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

* The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- * Z0-9-]{1,64} * /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0- * 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
* * @return

* The Amazon Resource Name (ARN) of the document classification * 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>:document-classification-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab *

*/ public String getJobArn() { return jobArn; } /** *

* The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- * Z0-9-]{1,64} * /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0- * 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
* * @param jobArn

* The Amazon Resource Name (ARN) of the document classification * 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>:document-classification-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab *

*/ public void setJobArn(String jobArn) { this.jobArn = jobArn; } /** *

* The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab *

*

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

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- * Z0-9-]{1,64} * /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0- * 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
* * @param jobArn

* The Amazon Resource Name (ARN) of the document classification * 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>:document-classification-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab *

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

* The status of the job: *

* *

* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, * STOP_REQUESTED, STOPPED * * @return

* The status of the job: *

* * @see JobStatus */ public String getJobStatus() { return jobStatus; } /** *

* The status of the job: *

* *

* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, * STOP_REQUESTED, STOPPED * * @param jobStatus

* The status of the job: *

* * @see JobStatus */ public void setJobStatus(String jobStatus) { this.jobStatus = jobStatus; } /** *

* The status of the job: *

* *

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

* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, * STOP_REQUESTED, STOPPED * * @param jobStatus

* The status of the job: *

* * @return A reference to this updated object so that method calls can be * chained together. * @see JobStatus */ public StartDocumentClassificationJobResult withJobStatus(String jobStatus) { this.jobStatus = jobStatus; return this; } /** *

* The status of the job: *

* *

* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, * STOP_REQUESTED, STOPPED * * @param jobStatus

* The status of the job: *

* * @see JobStatus */ public void setJobStatus(JobStatus jobStatus) { this.jobStatus = jobStatus.toString(); } /** *

* The status of the job: *

* *

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

* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, * STOP_REQUESTED, STOPPED * * @param jobStatus

* The status of the job: *

* * @return A reference to this updated object so that method calls can be * chained together. * @see JobStatus */ public StartDocumentClassificationJobResult withJobStatus(JobStatus jobStatus) { this.jobStatus = jobStatus.toString(); return this; } /** *

* The ARN of the custom classification model. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document * -classifier * /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @return

* The ARN of the custom classification model. *

*/ public String getDocumentClassifierArn() { return documentClassifierArn; } /** *

* The ARN of the custom classification model. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document * -classifier * /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @param documentClassifierArn

* The ARN of the custom classification model. *

*/ public void setDocumentClassifierArn(String documentClassifierArn) { this.documentClassifierArn = documentClassifierArn; } /** *

* The ARN of the custom classification model. *

*

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

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document * -classifier * /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @param documentClassifierArn

* The ARN of the custom classification model. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartDocumentClassificationJobResult withDocumentClassifierArn( String documentClassifierArn) { this.documentClassifierArn = documentClassifierArn; 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 (getJobId() != null) sb.append("JobId: " + getJobId() + ","); if (getJobArn() != null) sb.append("JobArn: " + getJobArn() + ","); if (getJobStatus() != null) sb.append("JobStatus: " + getJobStatus() + ","); if (getDocumentClassifierArn() != null) sb.append("DocumentClassifierArn: " + getDocumentClassifierArn()); sb.append("}"); return sb.toString(); } @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 + ((getJobStatus() == null) ? 0 : getJobStatus().hashCode()); hashCode = prime * hashCode + ((getDocumentClassifierArn() == null) ? 0 : getDocumentClassifierArn().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartDocumentClassificationJobResult == false) return false; StartDocumentClassificationJobResult other = (StartDocumentClassificationJobResult) 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.getJobStatus() == null ^ this.getJobStatus() == null) return false; if (other.getJobStatus() != null && other.getJobStatus().equals(this.getJobStatus()) == false) return false; if (other.getDocumentClassifierArn() == null ^ this.getDocumentClassifierArn() == null) return false; if (other.getDocumentClassifierArn() != null && other.getDocumentClassifierArn().equals(this.getDocumentClassifierArn()) == false) return false; return true; } }