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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class SearchVocabulariesRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchVocabulariesRequest()

Constructors
Constructor and Description
`SearchVocabulariesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.String`	`getLanguageCode()` The language code of the vocabulary entries.
`java.lang.Integer`	`getMaxResults()` The maximum number of results to return per page.
`java.lang.String`	`getNameStartsWith()` The starting pattern of the name of the vocabulary.
`java.lang.String`	`getNextToken()` The token for the next set of results.
`java.lang.String`	`getState()` The current state of the custom vocabulary.
`int`	`hashCode()`
`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`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`void`	`setNameStartsWith(java.lang.String nameStartsWith)` The starting pattern of the name of the vocabulary.
`void`	`setNextToken(java.lang.String nextToken)` The token for the next set of results.
`void`	`setState(java.lang.String state)` The current state of the custom vocabulary.
`void`	`setState(VocabularyState state)` The current state of the custom vocabulary.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SearchVocabulariesRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`SearchVocabulariesRequest`	`withLanguageCode(java.lang.String languageCode)` The language code of the vocabulary entries.
`SearchVocabulariesRequest`	`withLanguageCode(VocabularyLanguageCode languageCode)` The language code of the vocabulary entries.
`SearchVocabulariesRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`SearchVocabulariesRequest`	`withNameStartsWith(java.lang.String nameStartsWith)` The starting pattern of the name of the vocabulary.
`SearchVocabulariesRequest`	`withNextToken(java.lang.String nextToken)` The token for the next set of results.
`SearchVocabulariesRequest`	`withState(java.lang.String state)` The current state of the custom vocabulary.
`SearchVocabulariesRequest`	`withState(VocabularyState state)` The current state 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
  - SearchVocabulariesRequest
```
public SearchVocabulariesRequest()
```
- Method Detail
  - 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 SearchVocabulariesRequest 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.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of results to return per page.
    
    Constraints:
    Range: 1 - 100
    
    Returns:
    
    The maximum number of results to return per page.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page.
  - withMaxResults
```
public SearchVocabulariesRequest withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Constraints:
    Length: 1 - 131070
    Pattern: .*\S.*
    
    Returns:
    
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Constraints:
    Length: 1 - 131070
    Pattern: .*\S.*
    
    Parameters:
    
    nextToken -
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  - withNextToken
```
public SearchVocabulariesRequest withNextToken(java.lang.String nextToken)
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 131070
    Pattern: .*\S.*
    
    Parameters:
    
    nextToken -
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getState
```
public java.lang.String getState()
```
    The current state of the custom vocabulary.
    
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Returns:
    
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - setState
```
public void setState(java.lang.String state)
```
    The current state of the custom vocabulary.
    
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - withState
```
public SearchVocabulariesRequest withState(java.lang.String state)
```
    The current state of the custom vocabulary.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyState
  - setState
```
public void setState(VocabularyState state)
```
    The current state of the custom vocabulary.
    
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - withState
```
public SearchVocabulariesRequest withState(VocabularyState state)
```
    The current state of the custom vocabulary.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyState
  - getNameStartsWith
```
public java.lang.String getNameStartsWith()
```
    The starting pattern of the name of the vocabulary.
    
    Constraints:
    Length: 1 - 140
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    The starting pattern of the name of the vocabulary.
  - setNameStartsWith
```
public void setNameStartsWith(java.lang.String nameStartsWith)
```
    The starting pattern of the name of the vocabulary.
    
    Constraints:
    Length: 1 - 140
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    nameStartsWith -
    The starting pattern of the name of the vocabulary.
  - withNameStartsWith
```
public SearchVocabulariesRequest withNameStartsWith(java.lang.String nameStartsWith)
```
    The starting pattern of the name of the 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:
    
    nameStartsWith -
    The starting pattern of the name of the 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 SearchVocabulariesRequest 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 SearchVocabulariesRequest 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
  - 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 SearchVocabulariesRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SearchVocabulariesRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getMaxResults

setMaxResults

withMaxResults

getNextToken

setNextToken

withNextToken

getState

setState

withState

setState

withState

getNameStartsWith

setNameStartsWith

withNameStartsWith

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

toString

hashCode

equals