CallAnalyticsJobSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transcribe.model.CallAnalyticsJobSettings

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CallAnalyticsJobSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides optional settings for the CallAnalyticsJob operation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CallAnalyticsJobSettings()

Constructors
Constructor and Description
`CallAnalyticsJobSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CallAnalyticsJobSettings`	`clone()`
`boolean`	`equals(Object obj)`
`ContentRedaction`	`getContentRedaction()`
`String`	`getLanguageModelName()` The structure used to describe a custom language model.
`List<String>`	`getLanguageOptions()` 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.
`String`	`getVocabularyFilterMethod()` Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`String`	`getVocabularyFilterName()` The name of the vocabulary filter to use when running a call analytics job.
`String`	`getVocabularyName()` The name of a vocabulary to use when processing the call analytics job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContentRedaction(ContentRedaction contentRedaction)`
`void`	`setLanguageModelName(String languageModelName)` The structure used to describe a custom language model.
`void`	`setLanguageOptions(Collection<String> 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.
`void`	`setVocabularyFilterMethod(String vocabularyFilterMethod)` Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`void`	`setVocabularyFilterName(String vocabularyFilterName)` The name of the vocabulary filter to use when running a call analytics job.
`void`	`setVocabularyName(String vocabularyName)` The name of a vocabulary to use when processing the call analytics job.
`String`	`toString()` Returns a string representation of this object.
`CallAnalyticsJobSettings`	`withContentRedaction(ContentRedaction contentRedaction)`
`CallAnalyticsJobSettings`	`withLanguageModelName(String languageModelName)` The structure used to describe a custom language model.
`CallAnalyticsJobSettings`	`withLanguageOptions(Collection<String> 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.
`CallAnalyticsJobSettings`	`withLanguageOptions(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.
`CallAnalyticsJobSettings`	`withLanguageOptions(String... 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.
`CallAnalyticsJobSettings`	`withVocabularyFilterMethod(String vocabularyFilterMethod)` Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`CallAnalyticsJobSettings`	`withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)` Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`CallAnalyticsJobSettings`	`withVocabularyFilterName(String vocabularyFilterName)` The name of the vocabulary filter to use when running a call analytics job.
`CallAnalyticsJobSettings`	`withVocabularyName(String vocabularyName)` The name of a vocabulary to use when processing the call analytics job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CallAnalyticsJobSettings
```
public CallAnalyticsJobSettings()
```
- Method Detail
  - setVocabularyName
```
public void setVocabularyName(String vocabularyName)
```
    The name of a vocabulary to use when processing the call analytics job.
    
    Parameters:
    
    vocabularyName - The name of a vocabulary to use when processing the call analytics job.
  - getVocabularyName
```
public String getVocabularyName()
```
    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.
  - withVocabularyName
```
public CallAnalyticsJobSettings withVocabularyName(String vocabularyName)
```
    The name of a vocabulary to use when processing the call analytics job.
    
    Parameters:
    
    vocabularyName - The name of a vocabulary to use when processing the call analytics job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVocabularyFilterName
```
public void setVocabularyFilterName(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.
    
    Parameters:
    
    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.
  - getVocabularyFilterName
```
public String getVocabularyFilterName()
```
    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.
  - withVocabularyFilterName
```
public CallAnalyticsJobSettings withVocabularyFilterName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVocabularyFilterMethod
```
public void setVocabularyFilterMethod(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    VocabularyFilterMethod
  - getVocabularyFilterMethod
```
public String getVocabularyFilterMethod()
```
    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.
    
    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
  - withVocabularyFilterMethod
```
public CallAnalyticsJobSettings withVocabularyFilterMethod(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyFilterMethod
  - withVocabularyFilterMethod
```
public CallAnalyticsJobSettings withVocabularyFilterMethod(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyFilterMethod
  - setLanguageModelName
```
public void setLanguageModelName(String languageModelName)
```
    The structure used to describe a custom language model.
    
    Parameters:
    
    languageModelName - The structure used to describe a custom language model.
  - getLanguageModelName
```
public String getLanguageModelName()
```
    The structure used to describe a custom language model.
    
    Returns:
    
    The structure used to describe a custom language model.
  - withLanguageModelName
```
public CallAnalyticsJobSettings withLanguageModelName(String languageModelName)
```
    The structure used to describe a custom language model.
    
    Parameters:
    
    languageModelName - The structure used to describe a custom language model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentRedaction
```
public void setContentRedaction(ContentRedaction contentRedaction)
```
    Parameters:
    
    contentRedaction -
  - getContentRedaction
```
public ContentRedaction getContentRedaction()
```
    Returns:
  - withContentRedaction
```
public CallAnalyticsJobSettings withContentRedaction(ContentRedaction contentRedaction)
```
    Parameters:
    
    contentRedaction -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLanguageOptions
```
public List<String> getLanguageOptions()
```
    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 and language-specific features for additional information.
    
    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 and language-specific features for additional information.
    
    See Also:
    
    LanguageCode
  - setLanguageOptions
```
public void setLanguageOptions(Collection<String> 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 and language-specific features for additional information.
    
    Parameters:
    
    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 and language-specific features for additional information.
    
    See Also:
    
    LanguageCode
  - withLanguageOptions
```
public CallAnalyticsJobSettings withLanguageOptions(String... 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 and language-specific features for additional information.
    
    NOTE: This method appends the values to the existing list (if any). Use setLanguageOptions(java.util.Collection) or withLanguageOptions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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 and language-specific features for additional information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageOptions
```
public CallAnalyticsJobSettings withLanguageOptions(Collection<String> 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 and language-specific features for additional information.
    
    Parameters:
    
    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 and language-specific features for additional information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageOptions
```
public CallAnalyticsJobSettings withLanguageOptions(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 and language-specific features for additional information.
    
    Parameters:
    
    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 and language-specific features for additional information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CallAnalyticsJobSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CallAnalyticsJobSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CallAnalyticsJobSettings

Method Detail

setVocabularyName

getVocabularyName

withVocabularyName

setVocabularyFilterName

getVocabularyFilterName

withVocabularyFilterName

setVocabularyFilterMethod

getVocabularyFilterMethod

withVocabularyFilterMethod

withVocabularyFilterMethod

setLanguageModelName

getLanguageModelName

withLanguageModelName

setContentRedaction

getContentRedaction

withContentRedaction

getLanguageOptions

setLanguageOptions

withLanguageOptions

withLanguageOptions

withLanguageOptions

toString

equals

hashCode

clone

marshall