java.lang.Object
- software.amazon.awssdk.services.translate.model.TerminologyProperties

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TerminologyProperties.Builder,TerminologyProperties>

@Generated("software.amazon.awssdk:codegen")
public final class TerminologyProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TerminologyProperties.Builder,TerminologyProperties>

The properties of the custom terminology.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TerminologyProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the custom terminology.
`static TerminologyProperties.Builder`	`builder()`
`Instant`	`createdAt()`	The time at which the custom terminology was created, based on the timestamp.
`String`	`description()`	The description of the custom terminology properties.
`Directionality`	`directionality()`	The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
`String`	`directionalityAsString()`	The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
`EncryptionKey`	`encryptionKey()`	The encryption key for the custom terminology.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`TerminologyDataFormat`	`format()`	The format of the custom terminology input file.
`String`	`formatAsString()`	The format of the custom terminology input file.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTargetLanguageCodes()`	For responses, this returns true if the service returned a value for the TargetLanguageCodes property.
`Instant`	`lastUpdatedAt()`	The time at which the custom terminology was last update, based on the timestamp.
`String`	`message()`	Additional information from Amazon Translate about the terminology resource.
`String`	`name()`	The name of the custom terminology.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TerminologyProperties.Builder>`	`serializableBuilderClass()`
`Integer`	`sizeBytes()`	The size of the file used when importing a custom terminology.
`Integer`	`skippedTermCount()`	The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
`String`	`sourceLanguageCode()`	The language code for the source text of the translation request for which the custom terminology is being used.
`List<String>`	`targetLanguageCodes()`	The language codes for the target languages available with the custom terminology resource.
`Integer`	`termCount()`	The number of terms included in the custom terminology.
`TerminologyProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - name
```
public final String name()
```
    The name of the custom terminology.
    
    Returns:
    
    The name of the custom terminology.
  - description
```
public final String description()
```
    The description of the custom terminology properties.
    
    Returns:
    
    The description of the custom terminology properties.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the custom terminology.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the custom terminology.
  - sourceLanguageCode
```
public final String sourceLanguageCode()
```
    The language code for the source text of the translation request for which the custom terminology is being used.
    
    Returns:
    
    The language code for the source text of the translation request for which the custom terminology is being used.
  - 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 with the custom terminology resource. All possible target languages are returned in 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 with the custom terminology resource. All possible target languages are returned in array.
  - encryptionKey
```
public final EncryptionKey encryptionKey()
```
    The encryption key for the custom terminology.
    
    Returns:
    
    The encryption key for the custom terminology.
  - sizeBytes
```
public final Integer sizeBytes()
```
    The size of the file used when importing a custom terminology.
    
    Returns:
    
    The size of the file used when importing a custom terminology.
  - termCount
```
public final Integer termCount()
```
    The number of terms included in the custom terminology.
    
    Returns:
    
    The number of terms included in the custom terminology.
  - createdAt
```
public final Instant createdAt()
```
    The time at which the custom terminology was created, based on the timestamp.
    
    Returns:
    
    The time at which the custom terminology was created, based on the timestamp.
  - lastUpdatedAt
```
public final Instant lastUpdatedAt()
```
    The time at which the custom terminology was last update, based on the timestamp.
    
    Returns:
    
    The time at which the custom terminology was last update, based on the timestamp.
  - directionality
```
public final Directionality directionality()
```
    The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
    
    UNI
    
    The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
    
    MULTI
    
    Any language in the terminology resource can be the source language.
    
    If the service returns an enum value that is not available in the current SDK version, directionality will return Directionality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionalityAsString().
    
    Returns:
    
    The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
    
    UNI
    
    The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
    
    MULTI
    
    Any language in the terminology resource can be the source language.
    
    See Also:
    
    Directionality
  - directionalityAsString
```
public final String directionalityAsString()
```
    The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
    
    UNI
    
    The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
    
    MULTI
    
    Any language in the terminology resource can be the source language.
    
    If the service returns an enum value that is not available in the current SDK version, directionality will return Directionality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionalityAsString().
    
    Returns:
    
    The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
    
    UNI
    
    The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
    
    MULTI
    
    Any language in the terminology resource can be the source language.
    
    See Also:
    
    Directionality
  - message
```
public final String message()
```
    Additional information from Amazon Translate about the terminology resource.
    
    Returns:
    
    Additional information from Amazon Translate about the terminology resource.
  - skippedTermCount
```
public final Integer skippedTermCount()
```
    The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
    
    Returns:
    
    The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
  - format
```
public final TerminologyDataFormat format()
```
    The format of the custom terminology input file.
    
    If the service returns an enum value that is not available in the current SDK version, format will return TerminologyDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the custom terminology input file.
    
    See Also:
    
    TerminologyDataFormat
  - formatAsString
```
public final String formatAsString()
```
    The format of the custom terminology input file.
    
    If the service returns an enum value that is not available in the current SDK version, format will return TerminologyDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the custom terminology input file.
    
    See Also:
    
    TerminologyDataFormat
  - toBuilder
```
public TerminologyProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TerminologyProperties.Builder,TerminologyProperties>
  - builder
```
public static TerminologyProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TerminologyProperties.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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class TerminologyProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

description

arn

sourceLanguageCode

hasTargetLanguageCodes

targetLanguageCodes

encryptionKey

sizeBytes

termCount

createdAt

lastUpdatedAt

directionality

directionalityAsString

message

skippedTermCount

format

formatAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField