software.amazon.awssdk.services.translate.model

Class StartTextTranslationJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.translate.model.TranslateRequest

software.amazon.awssdk.services.translate.model.StartTextTranslationJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartTextTranslationJobRequest.Builder,StartTextTranslationJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartTextTranslationJobRequest
extends TranslateRequest
implements ToCopyableBuilder<StartTextTranslationJobRequest.Builder,StartTextTranslationJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartTextTranslationJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartTextTranslationJobRequest.Builder	builder()
String	clientToken() The client token of the EC2 instance calling the request.
String	dataAccessRoleArn() The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasTargetLanguageCodes() Returns true if the TargetLanguageCodes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTerminologyNames() Returns true if the TerminologyNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
InputDataConfig	inputDataConfig() Specifies the format and S3 location of the input documents for the translation job.
String	jobName() The name of the batch translation job to be performed.
OutputDataConfig	outputDataConfig() Specifies the S3 folder to which your job output will be saved.
List<SdkField<?>>	sdkFields()
static Class<? extends StartTextTranslationJobRequest.Builder>	serializableBuilderClass()
String	sourceLanguageCode() The language code of the input language.
List<String>	targetLanguageCodes() The language code of the output language.
List<String>	terminologyNames() The name of the terminology to use in the batch translation job.
StartTextTranslationJobRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobName

public String jobName()

The name of the batch translation job to be performed.

Returns:

The name of the batch translation job to be performed.

inputDataConfig

public InputDataConfig inputDataConfig()

Specifies the format and S3 location of the input documents for the translation job.

Returns:

Specifies the format and S3 location of the input documents for the translation job.

outputDataConfig

public OutputDataConfig outputDataConfig()

Specifies the S3 folder to which your job output will be saved.

Returns:

Specifies the S3 folder to which your job output will be saved.

dataAccessRoleArn

public String dataAccessRoleArn()

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management.

Returns:

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management.

sourceLanguageCode

public String sourceLanguageCode()

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

Returns:

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

hasTargetLanguageCodes

public boolean hasTargetLanguageCodes()

Returns true if the TargetLanguageCodes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targetLanguageCodes

public List<String> targetLanguageCodes()

The language code of the output language.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTargetLanguageCodes() to see if a value was sent in this field.

Returns:

The language code of the output language.

hasTerminologyNames

public boolean hasTerminologyNames()

Returns true if the TerminologyNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

terminologyNames

public List<String> terminologyNames()

The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTerminologyNames() to see if a value was sent in this field.

Returns:

The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

clientToken

public String clientToken()

The client token of the EC2 instance calling the request. This token is auto-generated when using the Amazon Translate SDK. Otherwise, use the DescribeInstances EC2 operation to retreive an instance's client token. For more information, see Client Tokens in the EC2 User Guide.

Returns:

The client token of the EC2 instance calling the request. This token is auto-generated when using the Amazon Translate SDK. Otherwise, use the DescribeInstances EC2 operation to retreive an instance's client token. For more information, see Client Tokens in the EC2 User Guide.

toBuilder

public StartTextTranslationJobRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartTextTranslationJobRequest.Builder,StartTextTranslationJobRequest>

Specified by:

toBuilder in class TranslateRequest

Returns:

a builder for type T

builder

public static StartTextTranslationJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartTextTranslationJobRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String toString()

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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.