StartTextTranslationJobRequest (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartTextTranslationJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartTextTranslationJobRequest.Builder`	`builder()`
`String`	`clientToken()` A unique identifier for 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`	`hasParallelDataNames()` Returns true if the ParallelDataNames 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`	`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<String>`	`parallelDataNames()` The names of the parallel data resources to use in the batch translation job.
`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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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.
  - hasParallelDataNames
```
public final boolean hasParallelDataNames()
```
    Returns true if the ParallelDataNames 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.
  - parallelDataNames
```
public final List<String> parallelDataNames()
```
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasParallelDataNames() to see if a value was sent in this field.
    
    Returns:
    
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
  - clientToken
```
public final String clientToken()
```
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
    
    Returns:
    
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final 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 final 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 final <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 final 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.

AWS SDK for Java API Reference - 2.16.46

Class StartTextTranslationJobRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

jobName

inputDataConfig

outputDataConfig

dataAccessRoleArn

sourceLanguageCode

hasTargetLanguageCodes

targetLanguageCodes

hasTerminologyNames

terminologyNames

hasParallelDataNames

parallelDataNames

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields