com.amazonaws.services.translate.model.StartTextTranslationJobResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-translate Show documentation
/*
* Copyright 2019-2024 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.translate.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartTextTranslationJobResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The identifier generated for the job. To get the status of a job, use this ID with the
* DescribeTextTranslationJob operation.
*
*/
private String jobId;
/**
*
* The status of the job. Possible values include:
*
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's
* output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
*
*/
private String jobStatus;
/**
*
* The identifier generated for the job. To get the status of a job, use this ID with the
* DescribeTextTranslationJob operation.
*
*
* @param jobId
* The identifier generated for the job. To get the status of a job, use this ID with the
* DescribeTextTranslationJob operation.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The identifier generated for the job. To get the status of a job, use this ID with the
* DescribeTextTranslationJob operation.
*
*
* @return The identifier generated for the job. To get the status of a job, use this ID with the
* DescribeTextTranslationJob operation.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The identifier generated for the job. To get the status of a job, use this ID with the
* DescribeTextTranslationJob operation.
*
*
* @param jobId
* The identifier generated for the job. To get the status of a job, use this ID with the
* DescribeTextTranslationJob operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTextTranslationJobResult withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The status of the job. Possible values include:
*
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's
* output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
*
*
* @param jobStatus
* The status of the job. Possible values include:
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the
* job's output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
* @see JobStatus
*/
public void setJobStatus(String jobStatus) {
this.jobStatus = jobStatus;
}
/**
*
* The status of the job. Possible values include:
*
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's
* output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
*
*
* @return The status of the job. Possible values include:
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the
* job's output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
* @see JobStatus
*/
public String getJobStatus() {
return this.jobStatus;
}
/**
*
* The status of the job. Possible values include:
*
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's
* output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
*
*
* @param jobStatus
* The status of the job. Possible values include:
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the
* job's output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public StartTextTranslationJobResult withJobStatus(String jobStatus) {
setJobStatus(jobStatus);
return this;
}
/**
*
* The status of the job. Possible values include:
*
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's
* output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
*
*
* @param jobStatus
* The status of the job. Possible values include:
*
* -
*
* SUBMITTED - The job has been received and is queued for processing.
*
*
* -
*
* IN_PROGRESS - Amazon Translate is processing the job.
*
*
* -
*
* COMPLETED - The job was successfully completed and the output is available.
*
*
* -
*
* COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the
* job's output.
*
*
* -
*
* FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
* operation.
*
*
* -
*
* STOP_REQUESTED - The user who started the job has requested that it be stopped.
*
*
* -
*
* STOPPED - The job has been stopped.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public StartTextTranslationJobResult withJobStatus(JobStatus jobStatus) {
this.jobStatus = jobStatus.toString();
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 (getJobStatus() != null)
sb.append("JobStatus: ").append(getJobStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartTextTranslationJobResult == false)
return false;
StartTextTranslationJobResult other = (StartTextTranslationJobResult) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getJobStatus() == null ^ this.getJobStatus() == null)
return false;
if (other.getJobStatus() != null && other.getJobStatus().equals(this.getJobStatus()) == 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 + ((getJobStatus() == null) ? 0 : getJobStatus().hashCode());
return hashCode;
}
@Override
public StartTextTranslationJobResult clone() {
try {
return (StartTextTranslationJobResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}