All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.translate.model.TextTranslationJobProperties Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Translate module holds the client classes that are used for communicating with Amazon Translate Service

There is a newer version: 1.12.778
Show newest version
/*
 * 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 

* Provides information about a translation job. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class TextTranslationJobProperties implements Serializable, Cloneable, StructuredPojo { /** *

* The ID of the translation job. *

*/ private String jobId; /** *

* The user-defined name of the translation job. *

*/ private String jobName; /** *

* The status of the translation job. *

*/ private String jobStatus; /** *

* The number of documents successfully and unsuccessfully processed during the translation job. *

*/ private JobDetails jobDetails; /** *

* The language code of the language of the source text. The language must be a language supported by Amazon * Translate. *

*/ private String sourceLanguageCode; /** *

* The language code of the language of the target text. The language must be a language supported by Amazon * Translate. *

*/ private java.util.List targetLanguageCodes; /** *

* A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. *

*/ private java.util.List terminologyNames; /** *

* A list containing the names of the parallel data resources applied to the translation job. *

*/ private java.util.List parallelDataNames; /** *

* An explanation of any errors that may have occurred during the translation job. *

*/ private String message; /** *

* The time at which the translation job was submitted. *

*/ private java.util.Date submittedTime; /** *

* The time at which the translation job ended. *

*/ private java.util.Date endTime; /** *

* The input configuration properties that were specified when the job was requested. *

*/ private InputDataConfig inputDataConfig; /** *

* The output configuration properties that were specified when the job was requested. *

*/ private OutputDataConfig outputDataConfig; /** *

* The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate * read access to the job's input data. *

*/ private String dataAccessRoleArn; /** *

* Settings that modify the translation output. *

*/ private TranslationSettings settings; /** *

* The ID of the translation job. *

* * @param jobId * The ID of the translation job. */ public void setJobId(String jobId) { this.jobId = jobId; } /** *

* The ID of the translation job. *

* * @return The ID of the translation job. */ public String getJobId() { return this.jobId; } /** *

* The ID of the translation job. *

* * @param jobId * The ID of the translation job. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withJobId(String jobId) { setJobId(jobId); return this; } /** *

* The user-defined name of the translation job. *

* * @param jobName * The user-defined name of the translation job. */ public void setJobName(String jobName) { this.jobName = jobName; } /** *

* The user-defined name of the translation job. *

* * @return The user-defined name of the translation job. */ public String getJobName() { return this.jobName; } /** *

* The user-defined name of the translation job. *

* * @param jobName * The user-defined name of the translation job. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withJobName(String jobName) { setJobName(jobName); return this; } /** *

* The status of the translation job. *

* * @param jobStatus * The status of the translation job. * @see JobStatus */ public void setJobStatus(String jobStatus) { this.jobStatus = jobStatus; } /** *

* The status of the translation job. *

* * @return The status of the translation job. * @see JobStatus */ public String getJobStatus() { return this.jobStatus; } /** *

* The status of the translation job. *

* * @param jobStatus * The status of the translation job. * @return Returns a reference to this object so that method calls can be chained together. * @see JobStatus */ public TextTranslationJobProperties withJobStatus(String jobStatus) { setJobStatus(jobStatus); return this; } /** *

* The status of the translation job. *

* * @param jobStatus * The status of the translation job. * @return Returns a reference to this object so that method calls can be chained together. * @see JobStatus */ public TextTranslationJobProperties withJobStatus(JobStatus jobStatus) { this.jobStatus = jobStatus.toString(); return this; } /** *

* The number of documents successfully and unsuccessfully processed during the translation job. *

* * @param jobDetails * The number of documents successfully and unsuccessfully processed during the translation job. */ public void setJobDetails(JobDetails jobDetails) { this.jobDetails = jobDetails; } /** *

* The number of documents successfully and unsuccessfully processed during the translation job. *

* * @return The number of documents successfully and unsuccessfully processed during the translation job. */ public JobDetails getJobDetails() { return this.jobDetails; } /** *

* The number of documents successfully and unsuccessfully processed during the translation job. *

* * @param jobDetails * The number of documents successfully and unsuccessfully processed during the translation job. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withJobDetails(JobDetails jobDetails) { setJobDetails(jobDetails); return this; } /** *

* The language code of the language of the source text. The language must be a language supported by Amazon * Translate. *

* * @param sourceLanguageCode * The language code of the language of the source text. The language must be a language supported by Amazon * Translate. */ public void setSourceLanguageCode(String sourceLanguageCode) { this.sourceLanguageCode = sourceLanguageCode; } /** *

* The language code of the language of the source text. The language must be a language supported by Amazon * Translate. *

* * @return The language code of the language of the source text. The language must be a language supported by Amazon * Translate. */ public String getSourceLanguageCode() { return this.sourceLanguageCode; } /** *

* The language code of the language of the source text. The language must be a language supported by Amazon * Translate. *

* * @param sourceLanguageCode * The language code of the language of the source text. The language must be a language supported by Amazon * Translate. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withSourceLanguageCode(String sourceLanguageCode) { setSourceLanguageCode(sourceLanguageCode); return this; } /** *

* The language code of the language of the target text. The language must be a language supported by Amazon * Translate. *

* * @return The language code of the language of the target text. The language must be a language supported by Amazon * Translate. */ public java.util.List getTargetLanguageCodes() { return targetLanguageCodes; } /** *

* The language code of the language of the target text. The language must be a language supported by Amazon * Translate. *

* * @param targetLanguageCodes * The language code of the language of the target text. The language must be a language supported by Amazon * Translate. */ public void setTargetLanguageCodes(java.util.Collection targetLanguageCodes) { if (targetLanguageCodes == null) { this.targetLanguageCodes = null; return; } this.targetLanguageCodes = new java.util.ArrayList(targetLanguageCodes); } /** *

* The language code of the language of the target text. The language must be a language supported by Amazon * Translate. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTargetLanguageCodes(java.util.Collection)} or {@link #withTargetLanguageCodes(java.util.Collection)} * if you want to override the existing values. *

* * @param targetLanguageCodes * The language code of the language of the target text. The language must be a language supported by Amazon * Translate. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withTargetLanguageCodes(String... targetLanguageCodes) { if (this.targetLanguageCodes == null) { setTargetLanguageCodes(new java.util.ArrayList(targetLanguageCodes.length)); } for (String ele : targetLanguageCodes) { this.targetLanguageCodes.add(ele); } return this; } /** *

* The language code of the language of the target text. The language must be a language supported by Amazon * Translate. *

* * @param targetLanguageCodes * The language code of the language of the target text. The language must be a language supported by Amazon * Translate. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withTargetLanguageCodes(java.util.Collection targetLanguageCodes) { setTargetLanguageCodes(targetLanguageCodes); return this; } /** *

* A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. *

* * @return A list containing the names of the terminologies applied to a translation job. Only one terminology can * be applied per StartTextTranslationJob request at this time. */ public java.util.List getTerminologyNames() { return terminologyNames; } /** *

* A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. *

* * @param terminologyNames * A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. */ public void setTerminologyNames(java.util.Collection terminologyNames) { if (terminologyNames == null) { this.terminologyNames = null; return; } this.terminologyNames = new java.util.ArrayList(terminologyNames); } /** *

* A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTerminologyNames(java.util.Collection)} or {@link #withTerminologyNames(java.util.Collection)} if you * want to override the existing values. *

* * @param terminologyNames * A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withTerminologyNames(String... terminologyNames) { if (this.terminologyNames == null) { setTerminologyNames(new java.util.ArrayList(terminologyNames.length)); } for (String ele : terminologyNames) { this.terminologyNames.add(ele); } return this; } /** *

* A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. *

* * @param terminologyNames * A list containing the names of the terminologies applied to a translation job. Only one terminology can be * applied per StartTextTranslationJob request at this time. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withTerminologyNames(java.util.Collection terminologyNames) { setTerminologyNames(terminologyNames); return this; } /** *

* A list containing the names of the parallel data resources applied to the translation job. *

* * @return A list containing the names of the parallel data resources applied to the translation job. */ public java.util.List getParallelDataNames() { return parallelDataNames; } /** *

* A list containing the names of the parallel data resources applied to the translation job. *

* * @param parallelDataNames * A list containing the names of the parallel data resources applied to the translation job. */ public void setParallelDataNames(java.util.Collection parallelDataNames) { if (parallelDataNames == null) { this.parallelDataNames = null; return; } this.parallelDataNames = new java.util.ArrayList(parallelDataNames); } /** *

* A list containing the names of the parallel data resources applied to the translation job. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setParallelDataNames(java.util.Collection)} or {@link #withParallelDataNames(java.util.Collection)} if * you want to override the existing values. *

* * @param parallelDataNames * A list containing the names of the parallel data resources applied to the translation job. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withParallelDataNames(String... parallelDataNames) { if (this.parallelDataNames == null) { setParallelDataNames(new java.util.ArrayList(parallelDataNames.length)); } for (String ele : parallelDataNames) { this.parallelDataNames.add(ele); } return this; } /** *

* A list containing the names of the parallel data resources applied to the translation job. *

* * @param parallelDataNames * A list containing the names of the parallel data resources applied to the translation job. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withParallelDataNames(java.util.Collection parallelDataNames) { setParallelDataNames(parallelDataNames); return this; } /** *

* An explanation of any errors that may have occurred during the translation job. *

* * @param message * An explanation of any errors that may have occurred during the translation job. */ public void setMessage(String message) { this.message = message; } /** *

* An explanation of any errors that may have occurred during the translation job. *

* * @return An explanation of any errors that may have occurred during the translation job. */ public String getMessage() { return this.message; } /** *

* An explanation of any errors that may have occurred during the translation job. *

* * @param message * An explanation of any errors that may have occurred during the translation job. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withMessage(String message) { setMessage(message); return this; } /** *

* The time at which the translation job was submitted. *

* * @param submittedTime * The time at which the translation job was submitted. */ public void setSubmittedTime(java.util.Date submittedTime) { this.submittedTime = submittedTime; } /** *

* The time at which the translation job was submitted. *

* * @return The time at which the translation job was submitted. */ public java.util.Date getSubmittedTime() { return this.submittedTime; } /** *

* The time at which the translation job was submitted. *

* * @param submittedTime * The time at which the translation job was submitted. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withSubmittedTime(java.util.Date submittedTime) { setSubmittedTime(submittedTime); return this; } /** *

* The time at which the translation job ended. *

* * @param endTime * The time at which the translation job ended. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** *

* The time at which the translation job ended. *

* * @return The time at which the translation job ended. */ public java.util.Date getEndTime() { return this.endTime; } /** *

* The time at which the translation job ended. *

* * @param endTime * The time at which the translation job ended. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** *

* The input configuration properties that were specified when the job was requested. *

* * @param inputDataConfig * The input configuration properties that were specified when the job was requested. */ public void setInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; } /** *

* The input configuration properties that were specified when the job was requested. *

* * @return The input configuration properties that were specified when the job was requested. */ public InputDataConfig getInputDataConfig() { return this.inputDataConfig; } /** *

* The input configuration properties that were specified when the job was requested. *

* * @param inputDataConfig * The input configuration properties that were specified when the job was requested. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withInputDataConfig(InputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** *

* The output configuration properties that were specified when the job was requested. *

* * @param outputDataConfig * The output configuration properties that were specified when the job was requested. */ public void setOutputDataConfig(OutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** *

* The output configuration properties that were specified when the job was requested. *

* * @return The output configuration properties that were specified when the job was requested. */ public OutputDataConfig getOutputDataConfig() { return this.outputDataConfig; } /** *

* The output configuration properties that were specified when the job was requested. *

* * @param outputDataConfig * The output configuration properties that were specified when the job was requested. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig) { setOutputDataConfig(outputDataConfig); return this; } /** *

* The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate * read access to the job's input data. *

* * @param dataAccessRoleArn * The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon * Translate read access to the job's input data. */ public void setDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; } /** *

* The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate * read access to the job's input data. *

* * @return The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon * Translate read access to the job's input data. */ public String getDataAccessRoleArn() { return this.dataAccessRoleArn; } /** *

* The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate * read access to the job's input data. *

* * @param dataAccessRoleArn * The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon * Translate read access to the job's input data. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(dataAccessRoleArn); return this; } /** *

* Settings that modify the translation output. *

* * @param settings * Settings that modify the translation output. */ public void setSettings(TranslationSettings settings) { this.settings = settings; } /** *

* Settings that modify the translation output. *

* * @return Settings that modify the translation output. */ public TranslationSettings getSettings() { return this.settings; } /** *

* Settings that modify the translation output. *

* * @param settings * Settings that modify the translation output. * @return Returns a reference to this object so that method calls can be chained together. */ public TextTranslationJobProperties withSettings(TranslationSettings settings) { setSettings(settings); 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 (getJobName() != null) sb.append("JobName: ").append(getJobName()).append(","); if (getJobStatus() != null) sb.append("JobStatus: ").append(getJobStatus()).append(","); if (getJobDetails() != null) sb.append("JobDetails: ").append(getJobDetails()).append(","); if (getSourceLanguageCode() != null) sb.append("SourceLanguageCode: ").append(getSourceLanguageCode()).append(","); if (getTargetLanguageCodes() != null) sb.append("TargetLanguageCodes: ").append(getTargetLanguageCodes()).append(","); if (getTerminologyNames() != null) sb.append("TerminologyNames: ").append(getTerminologyNames()).append(","); if (getParallelDataNames() != null) sb.append("ParallelDataNames: ").append(getParallelDataNames()).append(","); if (getMessage() != null) sb.append("Message: ").append(getMessage()).append(","); if (getSubmittedTime() != null) sb.append("SubmittedTime: ").append(getSubmittedTime()).append(","); if (getEndTime() != null) sb.append("EndTime: ").append(getEndTime()).append(","); if (getInputDataConfig() != null) sb.append("InputDataConfig: ").append(getInputDataConfig()).append(","); if (getOutputDataConfig() != null) sb.append("OutputDataConfig: ").append(getOutputDataConfig()).append(","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: ").append(getDataAccessRoleArn()).append(","); if (getSettings() != null) sb.append("Settings: ").append(getSettings()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof TextTranslationJobProperties == false) return false; TextTranslationJobProperties other = (TextTranslationJobProperties) obj; if (other.getJobId() == null ^ this.getJobId() == null) return false; if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == 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.getJobStatus() == null ^ this.getJobStatus() == null) return false; if (other.getJobStatus() != null && other.getJobStatus().equals(this.getJobStatus()) == false) return false; if (other.getJobDetails() == null ^ this.getJobDetails() == null) return false; if (other.getJobDetails() != null && other.getJobDetails().equals(this.getJobDetails()) == false) return false; if (other.getSourceLanguageCode() == null ^ this.getSourceLanguageCode() == null) return false; if (other.getSourceLanguageCode() != null && other.getSourceLanguageCode().equals(this.getSourceLanguageCode()) == false) return false; if (other.getTargetLanguageCodes() == null ^ this.getTargetLanguageCodes() == null) return false; if (other.getTargetLanguageCodes() != null && other.getTargetLanguageCodes().equals(this.getTargetLanguageCodes()) == false) return false; if (other.getTerminologyNames() == null ^ this.getTerminologyNames() == null) return false; if (other.getTerminologyNames() != null && other.getTerminologyNames().equals(this.getTerminologyNames()) == false) return false; if (other.getParallelDataNames() == null ^ this.getParallelDataNames() == null) return false; if (other.getParallelDataNames() != null && other.getParallelDataNames().equals(this.getParallelDataNames()) == false) return false; if (other.getMessage() == null ^ this.getMessage() == null) return false; if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false) return false; if (other.getSubmittedTime() == null ^ this.getSubmittedTime() == null) return false; if (other.getSubmittedTime() != null && other.getSubmittedTime().equals(this.getSubmittedTime()) == false) return false; if (other.getEndTime() == null ^ this.getEndTime() == null) return false; if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false) return false; 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.getSettings() == null ^ this.getSettings() == null) return false; if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == 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 + ((getJobName() == null) ? 0 : getJobName().hashCode()); hashCode = prime * hashCode + ((getJobStatus() == null) ? 0 : getJobStatus().hashCode()); hashCode = prime * hashCode + ((getJobDetails() == null) ? 0 : getJobDetails().hashCode()); hashCode = prime * hashCode + ((getSourceLanguageCode() == null) ? 0 : getSourceLanguageCode().hashCode()); hashCode = prime * hashCode + ((getTargetLanguageCodes() == null) ? 0 : getTargetLanguageCodes().hashCode()); hashCode = prime * hashCode + ((getTerminologyNames() == null) ? 0 : getTerminologyNames().hashCode()); hashCode = prime * hashCode + ((getParallelDataNames() == null) ? 0 : getParallelDataNames().hashCode()); hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode()); hashCode = prime * hashCode + ((getSubmittedTime() == null) ? 0 : getSubmittedTime().hashCode()); hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); 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 + ((getSettings() == null) ? 0 : getSettings().hashCode()); return hashCode; } @Override public TextTranslationJobProperties clone() { try { return (TextTranslationJobProperties) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.translate.model.transform.TextTranslationJobPropertiesMarshaller.getInstance().marshall(this, protocolMarshaller); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy