java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.transcribe.model.TranscribeRequest
    - - software.amazon.awssdk.services.transcribe.model.UpdateVocabularyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateVocabularyRequest
extends TranscribeRequest
implements ToCopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateVocabularyRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateVocabularyRequest.Builder`	`builder()`
`String`	`dataAccessRoleArn()`	The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPhrases()`	For responses, this returns true if the service returned a value for the Phrases property.
`LanguageCode`	`languageCode()`	The language code that represents the language of the entries in the custom vocabulary you want to update.
`String`	`languageCodeAsString()`	The language code that represents the language of the entries in the custom vocabulary you want to update.
`List<String>`	`phrases()`	Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateVocabularyRequest.Builder>`	`serializableBuilderClass()`
`UpdateVocabularyRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`vocabularyFileUri()`	The Amazon S3 location of the text file that contains your custom vocabulary.
`String`	`vocabularyName()`	The name of the custom vocabulary you want to update.

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
  - vocabularyName
```
public final String vocabularyName()
```
    The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.
    
    Returns:
    
    The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.
  - languageCode
```
public final LanguageCode languageCode()
```
    The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.
    
    A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.
    
    A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.
    
    A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.
    
    A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    See Also:
    
    LanguageCode
  - hasPhrases
```
public final boolean hasPhrases()
```
    For responses, this returns true if the service returned a value for the Phrases 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.
  - phrases
```
public final List<String> phrases()
```
    Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.
    
    Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.
    
    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your 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 hasPhrases() method.
    
    Returns:
    
    Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.
    
    Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.
    
    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
  - vocabularyFileUri
```
public final String vocabularyFileUri()
```
    The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
    
    Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
    
    Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.
    
    Returns:
    
    The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
    
    Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
    
    Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.
  - dataAccessRoleArn
```
public final String dataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
  - toBuilder
```
public UpdateVocabularyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>
    
    Specified by:
    
    toBuilder in class TranscribeRequest
  - builder
```
public static UpdateVocabularyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateVocabularyRequest.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 UpdateVocabularyRequest

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

vocabularyName

languageCode

languageCodeAsString

hasPhrases

phrases

vocabularyFileUri

dataAccessRoleArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields