CallAnalyticsJobSettings (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.transcribe.model.CallAnalyticsJobSettings

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CallAnalyticsJobSettings.Builder,CallAnalyticsJobSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class CallAnalyticsJobSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJobSettings.Builder,CallAnalyticsJobSettings>

Provides optional settings for the CallAnalyticsJob operation.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CallAnalyticsJobSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CallAnalyticsJobSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CallAnalyticsJobSettings.Builder`	`builder()`
`ContentRedaction`	`contentRedaction()` Returns the value of the ContentRedaction property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLanguageIdSettings()` For responses, this returns true if the service returned a value for the LanguageIdSettings property.
`boolean`	`hasLanguageOptions()` For responses, this returns true if the service returned a value for the LanguageOptions property.
`Map<LanguageCode,LanguageIdSettings>`	`languageIdSettings()` The language identification settings associated with your call analytics job.
`Map<String,LanguageIdSettings>`	`languageIdSettingsAsStrings()` The language identification settings associated with your call analytics job.
`String`	`languageModelName()` The structure used to describe a custom language model.
`List<LanguageCode>`	`languageOptions()` When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
`List<String>`	`languageOptionsAsStrings()` When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CallAnalyticsJobSettings.Builder>`	`serializableBuilderClass()`
`CallAnalyticsJobSettings.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VocabularyFilterMethod`	`vocabularyFilterMethod()` Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`String`	`vocabularyFilterMethodAsString()` Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`String`	`vocabularyFilterName()` The name of the vocabulary filter to use when running a call analytics job.
`String`	`vocabularyName()` The name of a vocabulary to use when processing the call analytics job.

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
  - vocabularyName
```
public final String vocabularyName()
```
    The name of a vocabulary to use when processing the call analytics job.
    
    Returns:
    
    The name of a vocabulary to use when processing the call analytics job.
  - vocabularyFilterName
```
public final String vocabularyFilterName()
```
    The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
    
    Returns:
    
    The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
  - vocabularyFilterMethod
```
public final VocabularyFilterMethod vocabularyFilterMethod()
```
    Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
    
    If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().
    
    Returns:
    
    Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
    
    See Also:
    
    VocabularyFilterMethod
  - vocabularyFilterMethodAsString
```
public final String vocabularyFilterMethodAsString()
```
    Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
    
    If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return VocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().
    
    Returns:
    
    Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
    
    See Also:
    
    VocabularyFilterMethod
  - languageModelName
```
public final String languageModelName()
```
    The structure used to describe a custom language model.
    
    Returns:
    
    The structure used to describe a custom language model.
  - contentRedaction
```
public final ContentRedaction contentRedaction()
```
    Returns the value of the ContentRedaction property for this object.
    
    Returns:
    
    The value of the ContentRedaction property for this object.
  - languageOptions
```
public final List<LanguageCode> languageOptions()
```
    When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
    
    To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
    
    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 hasLanguageOptions() method.
    
    Returns:
    
    When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
    
    To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
  - hasLanguageOptions
```
public final boolean hasLanguageOptions()
```
    For responses, this returns true if the service returned a value for the LanguageOptions 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.
  - languageOptionsAsStrings
```
public final List<String> languageOptionsAsStrings()
```
    When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
    
    To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
    
    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 hasLanguageOptions() method.
    
    Returns:
    
    When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
    
    To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
  - languageIdSettings
```
public final Map<LanguageCode,LanguageIdSettings> languageIdSettings()
```
    The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
    
    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 hasLanguageIdSettings() method.
    
    Returns:
    
    The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
  - hasLanguageIdSettings
```
public final boolean hasLanguageIdSettings()
```
    For responses, this returns true if the service returned a value for the LanguageIdSettings 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.
  - languageIdSettingsAsStrings
```
public final Map<String,LanguageIdSettings> languageIdSettingsAsStrings()
```
    The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
    
    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 hasLanguageIdSettings() method.
    
    Returns:
    
    The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
  - toBuilder
```
public CallAnalyticsJobSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CallAnalyticsJobSettings.Builder,CallAnalyticsJobSettings>
  - builder
```
public static CallAnalyticsJobSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CallAnalyticsJobSettings.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CallAnalyticsJobSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

vocabularyName

vocabularyFilterName

vocabularyFilterMethod

vocabularyFilterMethodAsString

languageModelName

contentRedaction

languageOptions

hasLanguageOptions

languageOptionsAsStrings

languageIdSettings

hasLanguageIdSettings

languageIdSettingsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields