/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connect.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Searches for vocabularies within a specific Amazon Connect instance using * State, NameStartsWith, and * LanguageCode. *

*/ public class SearchVocabulariesRequest extends AmazonWebServiceRequest implements Serializable { /** *

* 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
*/ private String instanceId; /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
*/ private Integer maxResults; /** *

* 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.*
*/ private String nextToken; /** *

* The current state of the custom vocabulary. *

*

* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, * DELETE_IN_PROGRESS */ private String state; /** *

* The starting pattern of the name of the vocabulary. *

*

* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String nameStartsWith; /** *

* 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 */ private String languageCode; /** *

* 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
* * @return

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *

*/ public String getInstanceId() { return 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
* * @param instanceId

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *

*/ public void setInstanceId(String instanceId) { this.instanceId = 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
* * @param instanceId

* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchVocabulariesRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
* * @return

* The maximum number of results to return per page. *

*/ public Integer getMaxResults() { return maxResults; } /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
* * @param maxResults

* The maximum number of results to return per page. *

*/ public void setMaxResults(Integer maxResults) { this.maxResults = 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
* * @param maxResults

* The maximum number of results to return per page. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchVocabulariesRequest withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** *

* 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.*
* * @return

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

*/ public String getNextToken() { return 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.*
* * @param 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. *

*/ public void setNextToken(String nextToken) { this.nextToken = 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.*
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchVocabulariesRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** *

* The current state of the custom vocabulary. *

*

* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, * DELETE_IN_PROGRESS * * @return

* The current state of the custom vocabulary. *

* @see VocabularyState */ public String getState() { return state; } /** *

* The current state of the custom vocabulary. *

*

* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, * DELETE_IN_PROGRESS * * @param state

* The current state of the custom vocabulary. *

* @see VocabularyState */ public void setState(String state) { this.state = 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 * * @param state

* The current state of the custom vocabulary. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyState */ public SearchVocabulariesRequest withState(String state) { this.state = state; return this; } /** *

* The current state of the custom vocabulary. *

*

* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, * DELETE_IN_PROGRESS * * @param state

* The current state of the custom vocabulary. *

* @see VocabularyState */ public void setState(VocabularyState state) { this.state = state.toString(); } /** *

* 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 * * @param state

* The current state of the custom vocabulary. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyState */ public SearchVocabulariesRequest withState(VocabularyState state) { this.state = state.toString(); return this; } /** *

* The starting pattern of the name of the vocabulary. *

*

* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

* The starting pattern of the name of the vocabulary. *

*/ public String getNameStartsWith() { return nameStartsWith; } /** *

* The starting pattern of the name of the vocabulary. *

*

* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
* * @param nameStartsWith

* The starting pattern of the name of the vocabulary. *

*/ public void setNameStartsWith(String nameStartsWith) { this.nameStartsWith = 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._-]+
* * @param nameStartsWith

* The starting pattern of the name of the vocabulary. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchVocabulariesRequest withNameStartsWith(String nameStartsWith) { this.nameStartsWith = nameStartsWith; return this; } /** *

* 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 * * @return

* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *

* @see VocabularyLanguageCode */ public String getLanguageCode() { return 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 * * @param languageCode

* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *

* @see VocabularyLanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = 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 * * @param languageCode

* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyLanguageCode */ public SearchVocabulariesRequest withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** *

* 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 * * @param languageCode

* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *

* @see VocabularyLanguageCode */ public void setLanguageCode(VocabularyLanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** *

* 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 * * @param languageCode

* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyLanguageCode */ public SearchVocabulariesRequest withLanguageCode(VocabularyLanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getInstanceId() != null) sb.append("InstanceId: " + getInstanceId() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ","); if (getState() != null) sb.append("State: " + getState() + ","); if (getNameStartsWith() != null) sb.append("NameStartsWith: " + getNameStartsWith() + ","); if (getLanguageCode() != null) sb.append("LanguageCode: " + getLanguageCode()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode()); hashCode = prime * hashCode + ((getNameStartsWith() == null) ? 0 : getNameStartsWith().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SearchVocabulariesRequest == false) return false; SearchVocabulariesRequest other = (SearchVocabulariesRequest) obj; if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false; if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getState() == null ^ this.getState() == null) return false; if (other.getState() != null && other.getState().equals(this.getState()) == false) return false; if (other.getNameStartsWith() == null ^ this.getNameStartsWith() == null) return false; if (other.getNameStartsWith() != null && other.getNameStartsWith().equals(this.getNameStartsWith()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; return true; } }