Package software.amazon.awssdk.services.transcribe.model

Class UpdateVocabularyFilterRequest

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.UpdateVocabularyFilterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateVocabularyFilterRequest.Builder,UpdateVocabularyFilterRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateVocabularyFilterRequest extends TranscribeRequest implements ToCopyableBuilder<UpdateVocabularyFilterRequest.Builder,UpdateVocabularyFilterRequest>

  • Method Details

    • vocabularyFilterName

      public final String vocabularyFilterName()

      The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.

      Returns:
      The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.

    • hasWords

      public final boolean hasWords()
      For responses, this returns true if the service returned a value for the Words 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.

    • words

      public final List<String> words()

      Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter 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 VocabularyFilterFileUri parameter.

      Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; 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 hasWords() method.

      Returns:
      Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter 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 VocabularyFilterFileUri parameter.

      Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; 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.

    • vocabularyFilterFileUri

      public final String vocabularyFilterFileUri()

      The Amazon S3 location of the text file that contains your custom vocabulary filter terms. 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-filter-file.txt

      Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

      Returns:
      The Amazon S3 location of the text file that contains your custom vocabulary filter terms. 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-filter-file.txt

      Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; 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 filter). 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 filter). 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 UpdateVocabularyFilterRequest.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<UpdateVocabularyFilterRequest.Builder,UpdateVocabularyFilterRequest>
      Specified by:
      toBuilder in class TranscribeRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateVocabularyFilterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateVocabularyFilterRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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