/*
* 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;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartEntitiesDetectionJobResult extends com.amazonaws.AmazonWebServiceResult
* The identifier generated for the job. To get the status of job, use this identifier with the operation.
*
* The Amazon Resource Name (ARN) of the entities detection 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:
*
*
* The following is an example job ARN:
*
*
* The status of the job.
*
* SUBMITTED - The job has been received and is queued for processing.
*
* IN_PROGRESS - Amazon Comprehend is processing the job.
*
* COMPLETED - The job was successfully completed and the output is available.
*
* FAILED - The job did not complete. To get details, use the operation.
*
* STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
*
* STOPPED - The job was successfully stopped without completing.
*
* The ARN of the custom entity recognition model.
*
* The identifier generated for the job. To get the status of job, use this identifier with the operation.
*
* The identifier generated for the job. To get the status of job, use this identifier with the operation.
*
* The identifier generated for the job. To get the status of job, use this identifier with the operation.
*
* The Amazon Resource Name (ARN) of the entities detection 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:
*
*
* The following is an example job ARN:
*
* arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
* arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
*
*
*/
private String jobStatus;
/**
* arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
* arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
*/
public void setJobArn(String jobArn) {
this.jobArn = jobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the entities detection 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>:entities-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
*/
public String getJobArn() {
return this.jobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the entities detection 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>:entities-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEntitiesDetectionJobResult withJobArn(String jobArn) {
setJobArn(jobArn);
return this;
}
/**
*
* The status of the job. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** The status of the job. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** The status of the job. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** The status of the job. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** SUBMITTED - The job has been received and is queued for processing. *
** IN_PROGRESS - Amazon Comprehend is processing the job. *
** COMPLETED - The job was successfully completed and the output is available. *
** FAILED - The job did not complete. To get details, use the operation. *
** STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. *
** STOPPED - The job was successfully stopped without completing. *
** The ARN of the custom entity recognition model. *
* * @param entityRecognizerArn * The ARN of the custom entity recognition model. */ public void setEntityRecognizerArn(String entityRecognizerArn) { this.entityRecognizerArn = entityRecognizerArn; } /** ** The ARN of the custom entity recognition model. *
* * @return The ARN of the custom entity recognition model. */ public String getEntityRecognizerArn() { return this.entityRecognizerArn; } /** ** The ARN of the custom entity recognition model. *
* * @param entityRecognizerArn * The ARN of the custom entity recognition model. * @return Returns a reference to this object so that method calls can be chained together. */ public StartEntitiesDetectionJobResult withEntityRecognizerArn(String entityRecognizerArn) { setEntityRecognizerArn(entityRecognizerArn); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @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: ").append(getJobId()).append(","); if (getJobArn() != null) sb.append("JobArn: ").append(getJobArn()).append(","); if (getJobStatus() != null) sb.append("JobStatus: ").append(getJobStatus()).append(","); if (getEntityRecognizerArn() != null) sb.append("EntityRecognizerArn: ").append(getEntityRecognizerArn()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartEntitiesDetectionJobResult == false) return false; StartEntitiesDetectionJobResult other = (StartEntitiesDetectionJobResult) 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.getEntityRecognizerArn() == null ^ this.getEntityRecognizerArn() == null) return false; if (other.getEntityRecognizerArn() != null && other.getEntityRecognizerArn().equals(this.getEntityRecognizerArn()) == false) return false; return true; } @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 + ((getEntityRecognizerArn() == null) ? 0 : getEntityRecognizerArn().hashCode()); return hashCode; } @Override public StartEntitiesDetectionJobResult clone() { try { return (StartEntitiesDetectionJobResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }