@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateVocabularyFilterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateVocabularyFilterRequest() |
Modifier and Type | Method and Description |
---|---|
CreateVocabularyFilterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getLanguageCode()
The language code that represents the language of the entries in your vocabulary filter.
|
List<Tag> |
getTags()
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time
you create this new filter.
|
String |
getVocabularyFilterFileUri()
The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
|
String |
getVocabularyFilterName()
A unique name, chosen by you, for your new custom vocabulary filter.
|
List<String> |
getWords()
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
int |
hashCode() |
void |
setLanguageCode(String languageCode)
The language code that represents the language of the entries in your vocabulary filter.
|
void |
setTags(Collection<Tag> tags)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time
you create this new filter.
|
void |
setVocabularyFilterFileUri(String vocabularyFilterFileUri)
The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
|
void |
setVocabularyFilterName(String vocabularyFilterName)
A unique name, chosen by you, for your new custom vocabulary filter.
|
void |
setWords(Collection<String> words)
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
String |
toString()
Returns a string representation of this object.
|
CreateVocabularyFilterRequest |
withLanguageCode(LanguageCode languageCode)
The language code that represents the language of the entries in your vocabulary filter.
|
CreateVocabularyFilterRequest |
withLanguageCode(String languageCode)
The language code that represents the language of the entries in your vocabulary filter.
|
CreateVocabularyFilterRequest |
withTags(Collection<Tag> tags)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time
you create this new filter.
|
CreateVocabularyFilterRequest |
withTags(Tag... tags)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time
you create this new filter.
|
CreateVocabularyFilterRequest |
withVocabularyFilterFileUri(String vocabularyFilterFileUri)
The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
|
CreateVocabularyFilterRequest |
withVocabularyFilterName(String vocabularyFilterName)
A unique name, chosen by you, for your new custom vocabulary filter.
|
CreateVocabularyFilterRequest |
withWords(Collection<String> words)
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
CreateVocabularyFilterRequest |
withWords(String... words)
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setVocabularyFilterName(String vocabularyFilterName)
A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If
you try to create a new vocabulary filter with the same name as an existing vocabulary filter, you get a
ConflictException
error.
vocabularyFilterName
- A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
account. If you try to create a new vocabulary filter with the same name as an existing vocabulary filter,
you get a ConflictException
error.
public String getVocabularyFilterName()
A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If
you try to create a new vocabulary filter with the same name as an existing vocabulary filter, you get a
ConflictException
error.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
account. If you try to create a new vocabulary filter with the same name as an existing vocabulary
filter, you get a ConflictException
error.
public CreateVocabularyFilterRequest withVocabularyFilterName(String vocabularyFilterName)
A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If
you try to create a new vocabulary filter with the same name as an existing vocabulary filter, you get a
ConflictException
error.
vocabularyFilterName
- A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
account. If you try to create a new vocabulary filter with the same name as an existing vocabulary filter,
you get a ConflictException
error.
public void setLanguageCode(String languageCode)
The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you
create a vocabulary filter using US English (en-US
), you can only apply this filter to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
languageCode
- The language code that represents the language of the entries in your vocabulary filter. Each vocabulary
filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example,
if you create a vocabulary filter using US English (en-US
), you can only apply this filter to
files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
LanguageCode
public String getLanguageCode()
The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you
create a vocabulary filter using US English (en-US
), you can only apply this filter to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example,
if you create a vocabulary filter using US English (en-US
), you can only apply this filter
to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
LanguageCode
public CreateVocabularyFilterRequest withLanguageCode(String languageCode)
The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you
create a vocabulary filter using US English (en-US
), you can only apply this filter to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
languageCode
- The language code that represents the language of the entries in your vocabulary filter. Each vocabulary
filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example,
if you create a vocabulary filter using US English (en-US
), you can only apply this filter to
files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
LanguageCode
public CreateVocabularyFilterRequest withLanguageCode(LanguageCode languageCode)
The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you
create a vocabulary filter using US English (en-US
), you can only apply this filter to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
languageCode
- The language code that represents the language of the entries in your vocabulary filter. Each vocabulary
filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example,
if you create a vocabulary filter using US English (en-US
), you can only apply this filter to
files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
LanguageCode
public List<String> getWords()
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public void setWords(Collection<String> words)
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
words
- Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public CreateVocabularyFilterRequest withWords(String... words)
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
NOTE: This method appends the values to the existing list (if any). Use
setWords(java.util.Collection)
or withWords(java.util.Collection)
if you want to override the
existing values.
words
- Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public CreateVocabularyFilterRequest withWords(Collection<String> words)
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
words
- Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public void setVocabularyFilterFileUri(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.
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.
public String getVocabularyFilterFileUri()
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.
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.
public CreateVocabularyFilterRequest withVocabularyFilterFileUri(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.
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.
public List<Tag> getTags()
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
public void setTags(Collection<Tag> tags)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
tags
- Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at
the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
public CreateVocabularyFilterRequest withTags(Tag... tags)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at
the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
public CreateVocabularyFilterRequest withTags(Collection<Tag> tags)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
tags
- Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at
the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
public String toString()
toString
in class Object
Object.toString()
public CreateVocabularyFilterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()