StartTextTranslationJobRequest (AWS Java SDK :: Services

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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParallelDataNames()` For responses, this returns true if the service returned a value for the ParallelDataNames property.
`boolean`	`hasTargetLanguageCodes()` For responses, this returns true if the service returned a value for the TargetLanguageCodes property.
`boolean`	`hasTerminologyNames()` For responses, this returns true if the service returned a value for the TerminologyNames property.
`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 name of a parallel data resource to add to the translation job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartTextTranslationJobRequest.Builder>`	`serializableBuilderClass()`
`TranslationSettings`	`settings()` Settings to configure your translation output, including the option to mask profane words and phrases.
`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 a custom terminology resource to add to the translation job.
`StartTextTranslationJobRequest.Builder`	`toBuilder()`
`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
clone, finalize, 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 information, 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 information, 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()
```
    For responses, this returns true if the service returned a value for the TargetLanguageCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetLanguageCodes() method.
    
    Returns:
    
    The language code of the output language.
  - hasTerminologyNames
```
public final boolean hasTerminologyNames()
```
    For responses, this returns true if the service returned a value for the TerminologyNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - terminologyNames
```
public final List<String> terminologyNames()
```
    The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.
    
    This parameter accepts only one custom terminology resource.
    
    For a list of available custom terminology resources, use the ListTerminologies operation.
    
    For more information, see how-custom-terminology.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTerminologyNames() method.
    
    Returns:
    
    The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.
    
    This parameter accepts only one custom terminology resource.
    
    For a list of available custom terminology resources, use the ListTerminologies operation.
    
    For more information, see how-custom-terminology.
  - hasParallelDataNames
```
public final boolean hasParallelDataNames()
```
    For responses, this returns true if the service returned a value for the ParallelDataNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parallelDataNames
```
public final List<String> parallelDataNames()
```
    The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.
    
    This parameter accepts only one parallel data resource.
    
    Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.
    
    For a list of available parallel data resources, use the ListParallelData operation.
    
    For more information, see customizing-translations-parallel-data.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParallelDataNames() method.
    
    Returns:
    
    The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.
    
    This parameter accepts only one parallel data resource.
    
    Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.
    
    For a list of available parallel data resources, use the ListParallelData operation.
    
    For more information, see customizing-translations-parallel-data.
  - 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.
  - settings
```
public final TranslationSettings settings()
```
    Settings to configure your translation output, including the option to mask profane words and phrases.
    
    Returns:
    
    Settings to configure your translation output, including the option to mask profane words and phrases.
  - toBuilder
```
public StartTextTranslationJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartTextTranslationJobRequest.Builder,StartTextTranslationJobRequest>
    
    Specified by:
    
    toBuilder in class TranslateRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

settings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields