software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect Show documentation
Show all versions of connect Show documentation
The AWS Java SDK for Connect module holds the client classes that are used for
communicating with Connect.
/*
* Copyright 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 software.amazon.awssdk.services.connect.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class SearchVocabulariesRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(SearchVocabulariesRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(SearchVocabulariesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(SearchVocabulariesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(SearchVocabulariesRequest::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField NAME_STARTS_WITH_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NameStartsWith").getter(getter(SearchVocabulariesRequest::nameStartsWith))
.setter(setter(Builder::nameStartsWith))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NameStartsWith").build()).build();
private static final SdkField LANGUAGE_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LanguageCode").getter(getter(SearchVocabulariesRequest::languageCodeAsString))
.setter(setter(Builder::languageCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LanguageCode").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, STATE_FIELD, NAME_STARTS_WITH_FIELD, LANGUAGE_CODE_FIELD));
private final String instanceId;
private final Integer maxResults;
private final String nextToken;
private final String state;
private final String nameStartsWith;
private final String languageCode;
private SearchVocabulariesRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.state = builder.state;
this.nameStartsWith = builder.nameStartsWith;
this.languageCode = builder.languageCode;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public final Integer maxResults() {
return 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.
*
*
* @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 final String nextToken() {
return nextToken;
}
/**
*
* The current state of the custom vocabulary.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link VocabularyState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the custom vocabulary.
* @see VocabularyState
*/
public final VocabularyState state() {
return VocabularyState.fromValue(state);
}
/**
*
* The current state of the custom vocabulary.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link VocabularyState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the custom vocabulary.
* @see VocabularyState
*/
public final String stateAsString() {
return state;
}
/**
*
* The starting pattern of the name of the vocabulary.
*
*
* @return The starting pattern of the name of the vocabulary.
*/
public final String nameStartsWith() {
return nameStartsWith;
}
/**
*
* The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
* What is Amazon Transcribe?
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #languageCode} will
* return {@link VocabularyLanguageCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #languageCodeAsString}.
*
*
* @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 final VocabularyLanguageCode languageCode() {
return VocabularyLanguageCode.fromValue(languageCode);
}
/**
*
* The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
* What is Amazon Transcribe?
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #languageCode} will
* return {@link VocabularyLanguageCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #languageCodeAsString}.
*
*
* @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 final String languageCodeAsString() {
return languageCode;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(nameStartsWith());
hashCode = 31 * hashCode + Objects.hashCode(languageCodeAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SearchVocabulariesRequest)) {
return false;
}
SearchVocabulariesRequest other = (SearchVocabulariesRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(nameStartsWith(), other.nameStartsWith())
&& Objects.equals(languageCodeAsString(), other.languageCodeAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("SearchVocabulariesRequest").add("InstanceId", instanceId()).add("MaxResults", maxResults())
.add("NextToken", nextToken()).add("State", stateAsString()).add("NameStartsWith", nameStartsWith())
.add("LanguageCode", languageCodeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "NameStartsWith":
return Optional.ofNullable(clazz.cast(nameStartsWith()));
case "LanguageCode":
return Optional.ofNullable(clazz.cast(languageCodeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchVocabulariesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The current state of the custom vocabulary.
*
*
* @param state
* The current state of the custom vocabulary.
* @see VocabularyState
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyState
*/
Builder state(String state);
/**
*
* The current state of the custom vocabulary.
*
*
* @param state
* The current state of the custom vocabulary.
* @see VocabularyState
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyState
*/
Builder state(VocabularyState state);
/**
*
* The starting pattern of the name of the vocabulary.
*
*
* @param nameStartsWith
* The starting pattern of the name of the vocabulary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nameStartsWith(String nameStartsWith);
/**
*
* The language code of the vocabulary entries. For a list of languages and their corresponding language codes,
* see What is Amazon
* Transcribe?
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyLanguageCode
*/
Builder languageCode(String languageCode);
/**
*
* The language code of the vocabulary entries. For a list of languages and their corresponding language codes,
* see What is Amazon
* Transcribe?
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyLanguageCode
*/
Builder languageCode(VocabularyLanguageCode languageCode);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private Integer maxResults;
private String nextToken;
private String state;
private String nameStartsWith;
private String languageCode;
private BuilderImpl() {
}
private BuilderImpl(SearchVocabulariesRequest model) {
super(model);
instanceId(model.instanceId);
maxResults(model.maxResults);
nextToken(model.nextToken);
state(model.state);
nameStartsWith(model.nameStartsWith);
languageCode(model.languageCode);
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(VocabularyState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final String getNameStartsWith() {
return nameStartsWith;
}
public final void setNameStartsWith(String nameStartsWith) {
this.nameStartsWith = nameStartsWith;
}
@Override
public final Builder nameStartsWith(String nameStartsWith) {
this.nameStartsWith = nameStartsWith;
return this;
}
public final String getLanguageCode() {
return languageCode;
}
public final void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
@Override
public final Builder languageCode(String languageCode) {
this.languageCode = languageCode;
return this;
}
@Override
public final Builder languageCode(VocabularyLanguageCode languageCode) {
this.languageCode(languageCode == null ? null : languageCode.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SearchVocabulariesRequest build() {
return new SearchVocabulariesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}