CreateVocabularyRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.CreateVocabularyRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateVocabularyRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateVocabularyRequest()

Constructors
Constructor and Description
`CreateVocabularyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateVocabularyRequest`	`addTagsEntry(java.lang.String key, java.lang.String value)` The tags used to organize, track, or control access for this resource.
`CreateVocabularyRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`java.lang.String`	`getContent()` The content of the custom vocabulary in plain-text format with a table of values.
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.String`	`getLanguageCode()` The language code of the vocabulary entries.
`java.util.Map<java.lang.String,java.lang.String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`java.lang.String`	`getVocabularyName()` A unique name of the custom vocabulary.
`int`	`hashCode()`
`void`	`setClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setContent(java.lang.String content)` The content of the custom vocabulary in plain-text format with a table of values.
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setLanguageCode(java.lang.String languageCode)` The language code of the vocabulary entries.
`void`	`setLanguageCode(VocabularyLanguageCode languageCode)` The language code of the vocabulary entries.
`void`	`setTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.
`void`	`setVocabularyName(java.lang.String vocabularyName)` A unique name of the custom vocabulary.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateVocabularyRequest`	`withClientToken(java.lang.String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`CreateVocabularyRequest`	`withContent(java.lang.String content)` The content of the custom vocabulary in plain-text format with a table of values.
`CreateVocabularyRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`CreateVocabularyRequest`	`withLanguageCode(java.lang.String languageCode)` The language code of the vocabulary entries.
`CreateVocabularyRequest`	`withLanguageCode(VocabularyLanguageCode languageCode)` The language code of the vocabulary entries.
`CreateVocabularyRequest`	`withTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.
`CreateVocabularyRequest`	`withVocabularyName(java.lang.String vocabularyName)` A unique name of the custom vocabulary.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateVocabularyRequest
```
public CreateVocabularyRequest()
```
- Method Detail
  - getClientToken
```
public java.lang.String getClientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
    
    Constraints:
    Length: - 500
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
  - setClientToken
```
public void setClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
    
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
  - withClientToken
```
public CreateVocabularyRequest withClientToken(java.lang.String clientToken)
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public CreateVocabularyRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getVocabularyName
```
public java.lang.String getVocabularyName()
```
    A unique name of the custom vocabulary.
    
    Constraints:
    Length: 1 - 140
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    A unique name of the custom vocabulary.
  - setVocabularyName
```
public void setVocabularyName(java.lang.String vocabularyName)
```
    A unique name of the custom vocabulary.
    
    Constraints:
    Length: 1 - 140
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    vocabularyName -
    A unique name of the custom vocabulary.
  - withVocabularyName
```
public CreateVocabularyRequest withVocabularyName(java.lang.String vocabularyName)
```
    A unique name of the custom vocabulary.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 140
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    vocabularyName -
    A unique name of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLanguageCode
```
public java.lang.String getLanguageCode()
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    Constraints:
    Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
    
    Returns:
    
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    See Also:
    
    VocabularyLanguageCode
  - setLanguageCode
```
public void setLanguageCode(java.lang.String languageCode)
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    Constraints:
    Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
    
    Parameters:
    
    languageCode -
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    See Also:
    
    VocabularyLanguageCode
  - withLanguageCode
```
public CreateVocabularyRequest withLanguageCode(java.lang.String languageCode)
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
    
    Parameters:
    
    languageCode -
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyLanguageCode
  - setLanguageCode
```
public void setLanguageCode(VocabularyLanguageCode languageCode)
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    Constraints:
    Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
    
    Parameters:
    
    languageCode -
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    See Also:
    
    VocabularyLanguageCode
  - withLanguageCode
```
public CreateVocabularyRequest withLanguageCode(VocabularyLanguageCode languageCode)
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
    
    Parameters:
    
    languageCode -
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyLanguageCode
  - getContent
```
public java.lang.String getContent()
```
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
    
    Constraints:
    Length: 1 - 60000
    
    Returns:
    
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
  - setContent
```
public void setContent(java.lang.String content)
```
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
    
    Constraints:
    Length: 1 - 60000
    
    Parameters:
    
    content -
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
  - withContent
```
public CreateVocabularyRequest withContent(java.lang.String content)
```
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 60000
    
    Parameters:
    
    content -
    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public java.util.Map<java.lang.String,java.lang.String> getTags()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - setTags
```
public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - withTags
```
public CreateVocabularyRequest withTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addTagsEntry
```
public CreateVocabularyRequest addTagsEntry(java.lang.String key,
                                            java.lang.String value)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Tags.
    
    value - The corresponding value of the entry to be added into Tags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearTagsEntries
```
public CreateVocabularyRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class CreateVocabularyRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateVocabularyRequest

Method Detail

getClientToken

setClientToken

withClientToken

getInstanceId

setInstanceId

withInstanceId

getVocabularyName

setVocabularyName

withVocabularyName

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

getContent

setContent

withContent

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

hashCode

equals