com.amazonaws.services.translate.model.InputDataConfig 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The input configuration properties for requesting a batch translation job.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InputDataConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the
* folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
*
*/
private String s3Uri;
/**
*
* Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the
* following multipurpose internet mail extension (MIME) types:
*
*
* -
*
* text/html: The input data consists of one or more HTML files. Amazon Translate translates only the
* text that resides in the html element in each file.
*
*
* -
*
* text/plain: The input data consists of one or more unformatted text files. Amazon Translate
* translates every character in this type of input.
*
*
* -
*
* application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of
* one or more Word documents (.docx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists
* of one or more PowerPoint Presentation files (.pptx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or
* more Excel Workbook files (.xlsx).
*
*
* -
*
* application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File
* Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
*
*
*
*
*
* If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing
* so, you cut costs by limiting the translation to the contents of the html element in each file.
* Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every
* character.
*
*
*/
private String contentType;
/**
*
* The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the
* folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
*
*
* @param s3Uri
* The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in
* the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are
* calling.
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the
* folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
*
*
* @return The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in
* the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are
* calling.
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the
* folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
*
*
* @param s3Uri
* The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in
* the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are
* calling.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InputDataConfig withS3Uri(String s3Uri) {
setS3Uri(s3Uri);
return this;
}
/**
*
* Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the
* following multipurpose internet mail extension (MIME) types:
*
*
* -
*
* text/html: The input data consists of one or more HTML files. Amazon Translate translates only the
* text that resides in the html element in each file.
*
*
* -
*
* text/plain: The input data consists of one or more unformatted text files. Amazon Translate
* translates every character in this type of input.
*
*
* -
*
* application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of
* one or more Word documents (.docx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists
* of one or more PowerPoint Presentation files (.pptx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or
* more Excel Workbook files (.xlsx).
*
*
* -
*
* application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File
* Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
*
*
*
*
*
* If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing
* so, you cut costs by limiting the translation to the contents of the html element in each file.
* Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every
* character.
*
*
*
* @param contentType
* Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the
* following multipurpose internet mail extension (MIME) types:
*
* -
*
* text/html: The input data consists of one or more HTML files. Amazon Translate translates
* only the text that resides in the html element in each file.
*
*
* -
*
* text/plain: The input data consists of one or more unformatted text files. Amazon Translate
* translates every character in this type of input.
*
*
* -
*
* application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data
* consists of one or more Word documents (.docx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data
* consists of one or more PowerPoint Presentation files (.pptx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of
* one or more Excel Workbook files (.xlsx).
*
*
* -
*
* application/x-xliff+xml: The input data consists of one or more XML Localization Interchange
* File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
*
*
*
*
*
* If you structure your input data as HTML, ensure that you set this parameter to text/html. By
* doing so, you cut costs by limiting the translation to the contents of the html element in
* each file. Otherwise, if you set this parameter to text/plain, your costs will cover the
* translation of every character.
*
*/
public void setContentType(String contentType) {
this.contentType = contentType;
}
/**
*
* Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the
* following multipurpose internet mail extension (MIME) types:
*
*
* -
*
* text/html: The input data consists of one or more HTML files. Amazon Translate translates only the
* text that resides in the html element in each file.
*
*
* -
*
* text/plain: The input data consists of one or more unformatted text files. Amazon Translate
* translates every character in this type of input.
*
*
* -
*
* application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of
* one or more Word documents (.docx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists
* of one or more PowerPoint Presentation files (.pptx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or
* more Excel Workbook files (.xlsx).
*
*
* -
*
* application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File
* Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
*
*
*
*
*
* If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing
* so, you cut costs by limiting the translation to the contents of the html element in each file.
* Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every
* character.
*
*
*
* @return Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the
* following multipurpose internet mail extension (MIME) types:
*
* -
*
* text/html: The input data consists of one or more HTML files. Amazon Translate translates
* only the text that resides in the html element in each file.
*
*
* -
*
* text/plain: The input data consists of one or more unformatted text files. Amazon Translate
* translates every character in this type of input.
*
*
* -
*
* application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data
* consists of one or more Word documents (.docx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data
* consists of one or more PowerPoint Presentation files (.pptx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists
* of one or more Excel Workbook files (.xlsx).
*
*
* -
*
* application/x-xliff+xml: The input data consists of one or more XML Localization Interchange
* File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
*
*
*
*
*
* If you structure your input data as HTML, ensure that you set this parameter to text/html.
* By doing so, you cut costs by limiting the translation to the contents of the html element
* in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the
* translation of every character.
*
*/
public String getContentType() {
return this.contentType;
}
/**
*
* Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the
* following multipurpose internet mail extension (MIME) types:
*
*
* -
*
* text/html: The input data consists of one or more HTML files. Amazon Translate translates only the
* text that resides in the html element in each file.
*
*
* -
*
* text/plain: The input data consists of one or more unformatted text files. Amazon Translate
* translates every character in this type of input.
*
*
* -
*
* application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of
* one or more Word documents (.docx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists
* of one or more PowerPoint Presentation files (.pptx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or
* more Excel Workbook files (.xlsx).
*
*
* -
*
* application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File
* Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
*
*
*
*
*
* If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing
* so, you cut costs by limiting the translation to the contents of the html element in each file.
* Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every
* character.
*
*
*
* @param contentType
* Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the
* following multipurpose internet mail extension (MIME) types:
*
* -
*
* text/html: The input data consists of one or more HTML files. Amazon Translate translates
* only the text that resides in the html element in each file.
*
*
* -
*
* text/plain: The input data consists of one or more unformatted text files. Amazon Translate
* translates every character in this type of input.
*
*
* -
*
* application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data
* consists of one or more Word documents (.docx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data
* consists of one or more PowerPoint Presentation files (.pptx).
*
*
* -
*
* application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of
* one or more Excel Workbook files (.xlsx).
*
*
* -
*
* application/x-xliff+xml: The input data consists of one or more XML Localization Interchange
* File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
*
*
*
*
*
* If you structure your input data as HTML, ensure that you set this parameter to text/html. By
* doing so, you cut costs by limiting the translation to the contents of the html element in
* each file. Otherwise, if you set this parameter to text/plain, your costs will cover the
* translation of every character.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InputDataConfig withContentType(String contentType) {
setContentType(contentType);
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 (getS3Uri() != null)
sb.append("S3Uri: ").append(getS3Uri()).append(",");
if (getContentType() != null)
sb.append("ContentType: ").append(getContentType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InputDataConfig == false)
return false;
InputDataConfig other = (InputDataConfig) obj;
if (other.getS3Uri() == null ^ this.getS3Uri() == null)
return false;
if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false)
return false;
if (other.getContentType() == null ^ this.getContentType() == null)
return false;
if (other.getContentType() != null && other.getContentType().equals(this.getContentType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode());
hashCode = prime * hashCode + ((getContentType() == null) ? 0 : getContentType().hashCode());
return hashCode;
}
@Override
public InputDataConfig clone() {
try {
return (InputDataConfig) 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.InputDataConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}