software.amazon.awssdk.services.connect.model.Vocabulary 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.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about a custom vocabulary.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Vocabulary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Vocabulary::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(Vocabulary::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(Vocabulary::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField LANGUAGE_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LanguageCode").getter(getter(Vocabulary::languageCodeAsString)).setter(setter(Builder::languageCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LanguageCode").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(Vocabulary::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField LAST_MODIFIED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTime").getter(getter(Vocabulary::lastModifiedTime))
.setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final SdkField FAILURE_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FailureReason").getter(getter(Vocabulary::failureReason)).setter(setter(Builder::failureReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FailureReason").build()).build();
private static final SdkField CONTENT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Content")
.getter(getter(Vocabulary::content)).setter(setter(Builder::content))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Content").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(Vocabulary::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, ID_FIELD,
ARN_FIELD, LANGUAGE_CODE_FIELD, STATE_FIELD, LAST_MODIFIED_TIME_FIELD, FAILURE_REASON_FIELD, CONTENT_FIELD,
TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String id;
private final String arn;
private final String languageCode;
private final String state;
private final Instant lastModifiedTime;
private final String failureReason;
private final String content;
private final Map tags;
private Vocabulary(BuilderImpl builder) {
this.name = builder.name;
this.id = builder.id;
this.arn = builder.arn;
this.languageCode = builder.languageCode;
this.state = builder.state;
this.lastModifiedTime = builder.lastModifiedTime;
this.failureReason = builder.failureReason;
this.content = builder.content;
this.tags = builder.tags;
}
/**
*
* A unique name of the custom vocabulary.
*
*
* @return A unique name of the custom vocabulary.
*/
public final String name() {
return name;
}
/**
*
* The identifier of the custom vocabulary.
*
*
* @return The identifier of the custom vocabulary.
*/
public final String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) of the custom vocabulary.
*
*
* @return The Amazon Resource Name (ARN) of the custom vocabulary.
*/
public final String arn() {
return arn;
}
/**
*
* 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;
}
/**
*
* 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 timestamp when the custom vocabulary was last modified.
*
*
* @return The timestamp when the custom vocabulary was last modified.
*/
public final Instant lastModifiedTime() {
return lastModifiedTime;
}
/**
*
* The reason why the custom vocabulary was not created.
*
*
* @return The reason why the custom vocabulary was not created.
*/
public final String failureReason() {
return failureReason;
}
/**
*
* 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. For more information, see Create a
* custom vocabulary using a table.
*
*
* @return 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. For
* more information, see Create a custom vocabulary using a table.
*/
public final String content() {
return content;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*/
public final Map tags() {
return tags;
}
@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 + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(languageCodeAsString());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
hashCode = 31 * hashCode + Objects.hashCode(failureReason());
hashCode = 31 * hashCode + Objects.hashCode(content());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Vocabulary)) {
return false;
}
Vocabulary other = (Vocabulary) obj;
return Objects.equals(name(), other.name()) && Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn())
&& Objects.equals(languageCodeAsString(), other.languageCodeAsString())
&& Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(lastModifiedTime(), other.lastModifiedTime())
&& Objects.equals(failureReason(), other.failureReason()) && Objects.equals(content(), other.content())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("Vocabulary").add("Name", name()).add("Id", id()).add("Arn", arn())
.add("LanguageCode", languageCodeAsString()).add("State", stateAsString())
.add("LastModifiedTime", lastModifiedTime()).add("FailureReason", failureReason()).add("Content", content())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "LanguageCode":
return Optional.ofNullable(clazz.cast(languageCodeAsString()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
case "FailureReason":
return Optional.ofNullable(clazz.cast(failureReason()));
case "Content":
return Optional.ofNullable(clazz.cast(content()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Vocabulary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A unique name of the custom vocabulary.
*
*
* @param name
* A unique name of the custom vocabulary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The identifier of the custom vocabulary.
*
*
* @param id
* The identifier of the custom vocabulary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The Amazon Resource Name (ARN) of the custom vocabulary.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the custom vocabulary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* 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);
/**
*
* 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 timestamp when the custom vocabulary was last modified.
*
*
* @param lastModifiedTime
* The timestamp when the custom vocabulary was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTime(Instant lastModifiedTime);
/**
*
* The reason why the custom vocabulary was not created.
*
*
* @param failureReason
* The reason why the custom vocabulary was not created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failureReason(String failureReason);
/**
*
* 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. For more information, see Create
* a custom vocabulary using a table.
*
*
* @param 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.
* For more information, see Create a custom vocabulary using a table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder content(String content);
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl implements Builder {
private String name;
private String id;
private String arn;
private String languageCode;
private String state;
private Instant lastModifiedTime;
private String failureReason;
private String content;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Vocabulary model) {
name(model.name);
id(model.id);
arn(model.arn);
languageCode(model.languageCode);
state(model.state);
lastModifiedTime(model.lastModifiedTime);
failureReason(model.failureReason);
content(model.content);
tags(model.tags);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
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;
}
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 Instant getLastModifiedTime() {
return lastModifiedTime;
}
public final void setLastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
@Override
public final Builder lastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
public final String getFailureReason() {
return failureReason;
}
public final void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
@Override
public final Builder failureReason(String failureReason) {
this.failureReason = failureReason;
return this;
}
public final String getContent() {
return content;
}
public final void setContent(String content) {
this.content = content;
}
@Override
public final Builder content(String content) {
this.content = content;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
@Override
public Vocabulary build() {
return new Vocabulary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}