Package software.amazon.awssdk.services.translate.model

Class TextTranslationJobProperties

java.lang.Object
software.amazon.awssdk.services.translate.model.TextTranslationJobProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TextTranslationJobProperties.Builder,TextTranslationJobProperties>
@Generated("software.amazon.awssdk:codegen") public final class TextTranslationJobProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TextTranslationJobProperties.Builder,TextTranslationJobProperties>

Provides information about a translation job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The ID of the translation job.

      Returns:
      The ID of the translation job.

    • jobName

      public final String jobName()

      The user-defined name of the translation job.

      Returns:
      The user-defined name of the translation job.

    • jobStatus

      public final JobStatus jobStatus()

      The status of the translation job.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The status of the translation job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The status of the translation job.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The status of the translation job.
      See Also:

    • jobDetails

      public final JobDetails jobDetails()

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

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

    • sourceLanguageCode

      public final String sourceLanguageCode()

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

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

    • 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 language of the target text. The language must be a language supported by Amazon Translate.

      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 language of the target text. The language must be a language supported by Amazon Translate.

    • 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()

      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.

      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:
      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.

    • 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()

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

      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:
      A list containing the names of the parallel data resources applied to the translation job.

    • message

      public final String message()

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

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

    • submittedTime

      public final Instant submittedTime()

      The time at which the translation job was submitted.

      Returns:
      The time at which the translation job was submitted.

    • endTime

      public final Instant endTime()

      The time at which the translation job ended.

      Returns:
      The time at which the translation job ended.

    • inputDataConfig

      public final InputDataConfig inputDataConfig()

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

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

    • outputDataConfig

      public final OutputDataConfig outputDataConfig()

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

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

    • dataAccessRoleArn

      public final String 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.

      Returns:
      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.

    • settings

      public final TranslationSettings settings()

      Settings that modify the translation output.

      Returns:
      Settings that modify the translation output.

    • toBuilder

      public TextTranslationJobProperties.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<TextTranslationJobProperties.Builder,TextTranslationJobProperties>
      Returns:
      a builder for type T

    • builder

      public static TextTranslationJobProperties.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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.