software.amazon.awssdk.services.connect.model

Class CreateVocabularyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.CreateVocabularyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateVocabularyRequest
extends ConnectRequest
implements ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateVocabularyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateVocabularyRequest.Builder	builder()
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	content() The content of the custom vocabulary in plain-text format with a table of values.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	instanceId() The identifier of the Amazon Connect instance.
VocabularyLanguageCode	languageCode() The language code of the vocabulary entries.
String	languageCodeAsString() The language code of the vocabulary entries.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateVocabularyRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags used to organize, track, or control access for this resource.
CreateVocabularyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyName() A unique name of the custom vocabulary.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientToken

public final 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 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.

instanceId

public final 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:

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

vocabularyName

public final String vocabularyName()

A unique name of the custom vocabulary.

Returns:

A unique name of the custom vocabulary.

languageCode

public final VocabularyLanguageCode 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, languageCode will return VocabularyLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

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

languageCodeAsString

public final String languageCodeAsString()

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, languageCode will return VocabularyLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

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

content

public final 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:

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.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

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 hasTags() method.

Returns:

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

toBuilder

public CreateVocabularyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static CreateVocabularyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateVocabularyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo