Class TerminologyProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TerminologyProperties.Builder,
TerminologyProperties>
The properties of the custom terminology.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the custom terminology.builder()
final Instant
The time at which the custom terminology was created, based on the timestamp.final String
The description of the custom terminology properties.final Directionality
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).final String
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).final EncryptionKey
The encryption key for the custom terminology.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final TerminologyDataFormat
format()
The format of the custom terminology input file.final String
The format of the custom terminology input file.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TargetLanguageCodes property.final Instant
The time at which the custom terminology was last update, based on the timestamp.final String
message()
Additional information from Amazon Translate about the terminology resource.final String
name()
The name of the custom terminology.static Class
<? extends TerminologyProperties.Builder> final Integer
The size of the file used when importing a custom terminology.final Integer
The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.final String
The language code for the source text of the translation request for which the custom terminology is being used.The language codes for the target languages available with the custom terminology resource.final Integer
The number of terms included in the custom terminology.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the custom terminology.
- Returns:
- The name of the custom terminology.
-
description
The description of the custom terminology properties.
- Returns:
- The description of the custom terminology properties.
-
arn
The Amazon Resource Name (ARN) of the custom terminology.
- Returns:
- The Amazon Resource Name (ARN) of the custom terminology.
-
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 theisEmpty()
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
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
The encryption key for the custom terminology.
- Returns:
- The encryption key for the custom terminology.
-
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
The number of terms included in the custom terminology.
- Returns:
- The number of terms included in the custom terminology.
-
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
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
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 returnDirectionality.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectionalityAsString()
.- 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:
-
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 returnDirectionality.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectionalityAsString()
.- 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:
-
message
Additional information from Amazon Translate about the terminology resource.
- Returns:
- Additional information from Amazon Translate about the terminology resource.
-
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
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 returnTerminologyDataFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- The format of the custom terminology input file.
- See Also:
-
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 returnTerminologyDataFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- The format of the custom terminology input file.
- See Also:
-
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 interfaceToCopyableBuilder<TerminologyProperties.Builder,
TerminologyProperties> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-