All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

• Constructor Summary

  Constructors

  Constructor and Description
  Settings ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  Settings	clone ()
  boolean	equals (Object obj)
  Boolean	getChannelIdentification () Enables channel identification in multi-channel audio.
  Integer	getMaxAlternatives () Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
  Integer	getMaxSpeakerLabels () Specify the maximum number of speakers you want to partition in your media.
  Boolean	getShowAlternatives () To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
  Boolean	getShowSpeakerLabels () Enables speaker partitioning (diarization) in your transcription output.
  String	getVocabularyFilterMethod () Specify how you want your custom vocabulary filter applied to your transcript.
  String	getVocabularyFilterName () The name of the custom vocabulary filter you want to use in your transcription job request.
  String	getVocabularyName () The name of the custom vocabulary you want to use in your transcription job request.
  int	hashCode ()
  Boolean	isChannelIdentification () Enables channel identification in multi-channel audio.
  Boolean	isShowAlternatives () To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
  Boolean	isShowSpeakerLabels () Enables speaker partitioning (diarization) in your transcription output.
  void	marshall (ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
  void	setChannelIdentification (Boolean channelIdentification) Enables channel identification in multi-channel audio.
  void	setMaxAlternatives (Integer maxAlternatives) Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
  void	setMaxSpeakerLabels (Integer maxSpeakerLabels) Specify the maximum number of speakers you want to partition in your media.
  void	setShowAlternatives (Boolean showAlternatives) To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
  void	setShowSpeakerLabels (Boolean showSpeakerLabels) Enables speaker partitioning (diarization) in your transcription output.
  void	setVocabularyFilterMethod (String vocabularyFilterMethod) Specify how you want your custom vocabulary filter applied to your transcript.
  void	setVocabularyFilterName (String vocabularyFilterName) The name of the custom vocabulary filter you want to use in your transcription job request.
  void	setVocabularyName (String vocabularyName) The name of the custom vocabulary you want to use in your transcription job request.
  String	toString () Returns a string representation of this object.
  Settings	withChannelIdentification (Boolean channelIdentification) Enables channel identification in multi-channel audio.
  Settings	withMaxAlternatives (Integer maxAlternatives) Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
  Settings	withMaxSpeakerLabels (Integer maxSpeakerLabels) Specify the maximum number of speakers you want to partition in your media.
  Settings	withShowAlternatives (Boolean showAlternatives) To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
  Settings	withShowSpeakerLabels (Boolean showSpeakerLabels) Enables speaker partitioning (diarization) in your transcription output.
  Settings	withVocabularyFilterMethod (String vocabularyFilterMethod) Specify how you want your custom vocabulary filter applied to your transcript.
  Settings	withVocabularyFilterMethod (VocabularyFilterMethod vocabularyFilterMethod) Specify how you want your custom vocabulary filter applied to your transcript.
  Settings	withVocabularyFilterName (String vocabularyFilterName) The name of the custom vocabulary filter you want to use in your transcription job request.
  Settings	withVocabularyName (String vocabularyName) The name of the custom vocabulary you want to use in your transcription job request.

  • 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 the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Parameters:

    vocabularyName - The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

  • getVocabularyName

    public String getVocabularyName()

    The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Returns:

    The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

  • withVocabularyName

    public Settings withVocabularyName(String vocabularyName)

    The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Parameters:

    vocabularyName - The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setShowSpeakerLabels

    public void setShowSpeakerLabels(Boolean showSpeakerLabels)

    Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .

    For more information, see Partitioning speakers (diarization).

    Parameters:

    showSpeakerLabels - Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

    For more information, see Partitioning speakers (diarization).

  • getShowSpeakerLabels

    public Boolean getShowSpeakerLabels()

    Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .

    For more information, see Partitioning speakers (diarization).

    Returns:

    Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

    For more information, see Partitioning speakers (diarization).

  • withShowSpeakerLabels

    public Settings withShowSpeakerLabels(Boolean showSpeakerLabels)

    Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .

    For more information, see Partitioning speakers (diarization).

    Parameters:

    showSpeakerLabels - Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

    For more information, see Partitioning speakers (diarization).

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isShowSpeakerLabels

    public Boolean isShowSpeakerLabels()

    Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels .

    For more information, see Partitioning speakers (diarization).

    Returns:

    Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

    If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

    For more information, see Partitioning speakers (diarization).

  • setMaxSpeakerLabels

    public void setMaxSpeakerLabels(Integer maxSpeakerLabels)

    Specify the maximum number of speakers you want to partition in your media.

    Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

    Parameters:

    maxSpeakerLabels - Specify the maximum number of speakers you want to partition in your media.

    Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

  • getMaxSpeakerLabels

    public Integer getMaxSpeakerLabels()

    Specify the maximum number of speakers you want to partition in your media.

    Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

    Returns:

    Specify the maximum number of speakers you want to partition in your media.

    Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

  • withMaxSpeakerLabels

    public Settings withMaxSpeakerLabels(Integer maxSpeakerLabels)

    Specify the maximum number of speakers you want to partition in your media.

    Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

    If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

    Parameters:

    maxSpeakerLabels - Specify the maximum number of speakers you want to partition in your media.

    Note that if your media contains more speakers than the specified number, multiple speakers are treated 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)

    Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

    Parameters:

    channelIdentification - Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

  • getChannelIdentification

    public Boolean getChannelIdentification()

    Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

    Returns:

    Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

  • withChannelIdentification

    public Settings withChannelIdentification(Boolean channelIdentification)

    Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

    Parameters:

    channelIdentification - Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isChannelIdentification

    public Boolean isChannelIdentification()

    Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

    Returns:

    Enables channel identification in multi-channel audio.

    Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

    For more information, see Transcribing multi-channel audio.

  • setShowAlternatives

    public void setShowAlternatives(Boolean showAlternatives)

    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

    Parameters:

    showAlternatives - To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

  • getShowAlternatives

    public Boolean getShowAlternatives()

    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

    Returns:

    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

  • withShowAlternatives

    public Settings withShowAlternatives(Boolean showAlternatives)

    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

    Parameters:

    showAlternatives - To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isShowAlternatives

    public Boolean isShowAlternatives()

    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

    Returns:

    To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

    If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

    If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

    For more information, see Alternative transcriptions.

  • setMaxAlternatives

    public void setMaxAlternatives(Integer maxAlternatives)

    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

    For more information, see Alternative transcriptions.

    Parameters:

    maxAlternatives - Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

    For more information, see Alternative transcriptions.

  • getMaxAlternatives

    public Integer getMaxAlternatives()

    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

    For more information, see Alternative transcriptions.

    Returns:

    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

    For more information, see Alternative transcriptions.

  • withMaxAlternatives

    public Settings withMaxAlternatives(Integer maxAlternatives)

    Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

    For more information, see Alternative transcriptions.

    Parameters:

    maxAlternatives - Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

    If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

    If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

    For more information, see Alternative transcriptions.

    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 custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

    Parameters:

    vocabularyFilterName - The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

  • getVocabularyFilterName

    public String getVocabularyFilterName()

    The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

    Returns:

    The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

  • withVocabularyFilterName

    public Settings withVocabularyFilterName(String vocabularyFilterName)

    The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

    Parameters:

    vocabularyFilterName - The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setVocabularyFilterMethod

    public void setVocabularyFilterMethod(String vocabularyFilterMethod)

    Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    Parameters:

    vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    See Also:

    VocabularyFilterMethod

  • getVocabularyFilterMethod

    public String getVocabularyFilterMethod()

    Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    Returns:

    Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    See Also:

    VocabularyFilterMethod

  • withVocabularyFilterMethod

    public Settings withVocabularyFilterMethod(String vocabularyFilterMethod)

    Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    Parameters:

    vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    VocabularyFilterMethod

  • withVocabularyFilterMethod

    public Settings withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)

    Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    Parameters:

    vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.

    To replace words with ***, choose mask.

    To delete words, choose remove.

    To flag words without changing them, choose tag.

    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.