Class ParallelDataProperties

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

The properties of a parallel data resource.

See Also:

  • Method Details

    • name

      public final String name()

      The custom name assigned to the parallel data resource.

      Returns:
      The custom name assigned to the parallel data resource.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the parallel data resource.

      Returns:
      The Amazon Resource Name (ARN) of the parallel data resource.

    • description

      public final String description()

      The description assigned to the parallel data resource.

      Returns:
      The description assigned to the parallel data resource.

    • status

      public final ParallelDataStatus status()

      The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.

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

      Returns:
      The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.

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

      Returns:
      The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.
      See Also:

    • sourceLanguageCode

      public final String sourceLanguageCode()

      The source language of the translations in the parallel data file.

      Returns:
      The source language of the translations in the parallel data file.

    • 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 codes for the target languages available in the parallel data file. All possible target languages are returned as an array.

      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 codes for the target languages available in the parallel data file. All possible target languages are returned as an array.

    • parallelDataConfig

      public final ParallelDataConfig parallelDataConfig()

      Specifies the format and S3 location of the parallel data input file.

      Returns:
      Specifies the format and S3 location of the parallel data input file.

    • message

      public final String message()

      Additional information from Amazon Translate about the parallel data resource.

      Returns:
      Additional information from Amazon Translate about the parallel data resource.

    • importedDataSize

      public final Long importedDataSize()

      The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.

      Returns:
      The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.

    • importedRecordCount

      public final Long importedRecordCount()

      The number of records successfully imported from the parallel data input file.

      Returns:
      The number of records successfully imported from the parallel data input file.

    • failedRecordCount

      public final Long failedRecordCount()

      The number of records unsuccessfully imported from the parallel data input file.

      Returns:
      The number of records unsuccessfully imported from the parallel data input file.

    • skippedRecordCount

      public final Long skippedRecordCount()

      The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.

      Returns:
      The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.

    • encryptionKey

      public final EncryptionKey encryptionKey()
      Returns the value of the EncryptionKey property for this object.
      Returns:
      The value of the EncryptionKey property for this object.

    • createdAt

      public final Instant createdAt()

      The time at which the parallel data resource was created.

      Returns:
      The time at which the parallel data resource was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The time at which the parallel data resource was last updated.

      Returns:
      The time at which the parallel data resource was last updated.

    • latestUpdateAttemptStatus

      public final ParallelDataStatus latestUpdateAttemptStatus()

      The status of the most recent update attempt for the parallel data resource.

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

      Returns:
      The status of the most recent update attempt for the parallel data resource.
      See Also:

    • latestUpdateAttemptStatusAsString

      public final String latestUpdateAttemptStatusAsString()

      The status of the most recent update attempt for the parallel data resource.

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

      Returns:
      The status of the most recent update attempt for the parallel data resource.
      See Also:

    • latestUpdateAttemptAt

      public final Instant latestUpdateAttemptAt()

      The time that the most recent update was attempted.

      Returns:
      The time that the most recent update was attempted.

    • toBuilder

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

    • builder

      public static ParallelDataProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParallelDataProperties.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.