Settings (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Settings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides optional settings for the StartTranscriptionJob operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Settings`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getChannelIdentification()` Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
`Integer`	`getMaxAlternatives()` The number of alternative transcriptions that the service should return.
`Integer`	`getMaxSpeakerLabels()` The maximum number of speakers to identify in the input audio.
`Boolean`	`getShowAlternatives()` Determines whether the transcription contains alternative transcriptions.
`Boolean`	`getShowSpeakerLabels()` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`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 transcribing the audio.
`String`	`getVocabularyName()` The name of a vocabulary to use when processing the transcription job.
`int`	`hashCode()`
`Boolean`	`isChannelIdentification()` Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
`Boolean`	`isShowAlternatives()` Determines whether the transcription contains alternative transcriptions.
`Boolean`	`isShowSpeakerLabels()` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelIdentification(Boolean channelIdentification)` Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
`void`	`setMaxAlternatives(Integer maxAlternatives)` The number of alternative transcriptions that the service should return.
`void`	`setMaxSpeakerLabels(Integer maxSpeakerLabels)` The maximum number of speakers to identify in the input audio.
`void`	`setShowAlternatives(Boolean showAlternatives)` Determines whether the transcription contains alternative transcriptions.
`void`	`setShowSpeakerLabels(Boolean showSpeakerLabels)` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`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 transcribing the audio.
`void`	`setVocabularyName(String vocabularyName)` The name of a vocabulary to use when processing the transcription job.
`String`	`toString()` Returns a string representation of this object.
`Settings`	`withChannelIdentification(Boolean channelIdentification)` Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
`Settings`	`withMaxAlternatives(Integer maxAlternatives)` The number of alternative transcriptions that the service should return.
`Settings`	`withMaxSpeakerLabels(Integer maxSpeakerLabels)` The maximum number of speakers to identify in the input audio.
`Settings`	`withShowAlternatives(Boolean showAlternatives)` Determines whether the transcription contains alternative transcriptions.
`Settings`	`withShowSpeakerLabels(Boolean showSpeakerLabels)` Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio.
`Settings`	`withVocabularyFilterMethod(String vocabularyFilterMethod)` Set to `mask` to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`Settings`	`withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)` Set to `mask` to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
`Settings`	`withVocabularyFilterName(String vocabularyFilterName)` The name of the vocabulary filter to use when transcribing the audio.
`Settings`	`withVocabularyName(String vocabularyName)` The name of a vocabulary to use when processing the transcription job.

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

- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - setVocabularyName
```
public void setVocabularyName(String vocabularyName)
```
    The name of a vocabulary to use when processing the transcription job.
    
    Parameters:
    
    vocabularyName - The name of a vocabulary to use when processing the transcription job.
  - getVocabularyName
```
public String getVocabularyName()
```
    The name of a vocabulary to use when processing the transcription job.
    
    Returns:
    
    The name of a vocabulary to use when processing the transcription job.
  - withVocabularyName
```
public Settings withVocabularyName(String vocabularyName)
```
    The name of a vocabulary to use when processing the transcription job.
    
    Parameters:
    
    vocabularyName - The name of a vocabulary to use when processing the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setShowSpeakerLabels
```
public void setShowSpeakerLabels(Boolean showSpeakerLabels)
```
    Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Parameters:
    
    showSpeakerLabels - Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
  - getShowSpeakerLabels
```
public Boolean getShowSpeakerLabels()
```
    Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Returns:
    
    Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
  - withShowSpeakerLabels
```
public Settings withShowSpeakerLabels(Boolean showSpeakerLabels)
```
    Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Parameters:
    
    showSpeakerLabels - Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowSpeakerLabels
```
public Boolean isShowSpeakerLabels()
```
    Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Returns:
    
    Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
  - setMaxSpeakerLabels
```
public void setMaxSpeakerLabels(Integer maxSpeakerLabels)
```
    The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
    
    Parameters:
    
    maxSpeakerLabels - The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
  - getMaxSpeakerLabels
```
public Integer getMaxSpeakerLabels()
```
    The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
    
    Returns:
    
    The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
  - withMaxSpeakerLabels
```
public Settings withMaxSpeakerLabels(Integer maxSpeakerLabels)
```
    The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
    
    Parameters:
    
    maxSpeakerLabels - The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelIdentification
```
public void setChannelIdentification(Boolean channelIdentification)
```
    Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Parameters:
    
    channelIdentification - Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
  - getChannelIdentification
```
public Boolean getChannelIdentification()
```
    Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Returns:
    
    Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
  - withChannelIdentification
```
public Settings withChannelIdentification(Boolean channelIdentification)
```
    Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Parameters:
    
    channelIdentification - Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isChannelIdentification
```
public Boolean isChannelIdentification()
```
    Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Returns:
    
    Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
    
    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
  - setShowAlternatives
```
public void setShowAlternatives(Boolean showAlternatives)
```
    Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
    
    Parameters:
    
    showAlternatives - Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
  - getShowAlternatives
```
public Boolean getShowAlternatives()
```
    Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
    
    Returns:
    
    Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
  - withShowAlternatives
```
public Settings withShowAlternatives(Boolean showAlternatives)
```
    Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
    
    Parameters:
    
    showAlternatives - Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowAlternatives
```
public Boolean isShowAlternatives()
```
    Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
    
    Returns:
    
    Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
  - setMaxAlternatives
```
public void setMaxAlternatives(Integer maxAlternatives)
```
    The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
    
    Parameters:
    
    maxAlternatives - The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
  - getMaxAlternatives
```
public Integer getMaxAlternatives()
```
    The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
    
    Returns:
    
    The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
  - withMaxAlternatives
```
public Settings withMaxAlternatives(Integer maxAlternatives)
```
    The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
    
    Parameters:
    
    maxAlternatives - The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
    
    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 transcribing the audio. The filter that you specify must have the same language code as the transcription job.
    
    Parameters:
    
    vocabularyFilterName - The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
  - getVocabularyFilterName
```
public String getVocabularyFilterName()
```
    The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
    
    Returns:
    
    The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
  - withVocabularyFilterName
```
public Settings withVocabularyFilterName(String vocabularyFilterName)
```
    The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
    
    Parameters:
    
    vocabularyFilterName - The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription 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.
    
    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.
    
    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.
    
    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.
    
    See Also:
    
    VocabularyFilterMethod
  - withVocabularyFilterMethod
```
public Settings 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyFilterMethod
  - withVocabularyFilterMethod
```
public Settings 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyFilterMethod
  - 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 Settings 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 Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

setVocabularyName

getVocabularyName

withVocabularyName

setShowSpeakerLabels

getShowSpeakerLabels

withShowSpeakerLabels

isShowSpeakerLabels

setMaxSpeakerLabels

getMaxSpeakerLabels

withMaxSpeakerLabels

setChannelIdentification

getChannelIdentification

withChannelIdentification

isChannelIdentification

setShowAlternatives

getShowAlternatives

withShowAlternatives

isShowAlternatives

setMaxAlternatives

getMaxAlternatives

withMaxAlternatives

setVocabularyFilterName

getVocabularyFilterName

withVocabularyFilterName

setVocabularyFilterMethod

getVocabularyFilterMethod

withVocabularyFilterMethod

withVocabularyFilterMethod

toString

equals

hashCode

clone

marshall