/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.transcribe.model; import java.io.Serializable; /** *

* Allows additional optional settings in your request, including channel * identification, alternative transcriptions, and speaker partitioning. You can * use that to apply custom vocabularies to your transcription job. *

*/ public class Settings implements Serializable { /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String vocabularyName; /** *

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

*/ private Boolean showSpeakerLabels; /** *

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

*

* Constraints:
* Range: 2 - 10
*/ private Integer maxSpeakerLabels; /** *

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

*/ private Boolean channelIdentification; /** *

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

*/ private Boolean showAlternatives; /** *

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

*

* Constraints:
* Range: 2 - 10
*/ private Integer maxAlternatives; /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String vocabularyFilterName; /** *

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

*

* Constraints:
* Allowed Values: remove, mask, tag */ private String vocabularyFilterMethod; /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

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

*/ public String getVocabularyName() { return 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

*/ public void setVocabularyName(String vocabularyName) { this.vocabularyName = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public Settings withVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; return this; } /** *

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

* * @return

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including * both parameters returns a BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

*/ public Boolean isShowSpeakerLabels() { return 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

* * @return

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including * both parameters returns a BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

*/ public Boolean getShowSpeakerLabels() { return 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

* * @param 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. * Including both parameters returns a * BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

*/ public void setShowSpeakerLabels(Boolean showSpeakerLabels) { this.showSpeakerLabels = 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. * Including both parameters returns a * BadRequestException. *

*

* For more information, see Partitioning speakers (diarization). *

* @return A reference to this updated object so that method calls can be * chained together. */ public Settings withShowSpeakerLabels(Boolean showSpeakerLabels) { this.showSpeakerLabels = showSpeakerLabels; return this; } /** *

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

*

* Constraints:
* Range: 2 - 10
* * @return

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

*/ public Integer getMaxSpeakerLabels() { return 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. *

*

* Constraints:
* Range: 2 - 10
* * @param 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. *

*/ public void setMaxSpeakerLabels(Integer maxSpeakerLabels) { this.maxSpeakerLabels = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 2 - 10
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public Settings withMaxSpeakerLabels(Integer maxSpeakerLabels) { this.maxSpeakerLabels = maxSpeakerLabels; return this; } /** *

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

* * @return

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including * both parameters returns a BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

*/ public Boolean isChannelIdentification() { return 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

* * @return

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

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including * both parameters returns a BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

*/ public Boolean getChannelIdentification() { return 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

* * @param 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. * Including both parameters returns a * BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

*/ public void setChannelIdentification(Boolean channelIdentification) { this.channelIdentification = 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. Including both * parameters returns a BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

*

* You can't include both ShowSpeakerLabels and * ChannelIdentification in the same request. * Including both parameters returns a * BadRequestException. *

*

* For more information, see Transcribing multi-channel audio. *

* @return A reference to this updated object so that method calls can be * chained together. */ public Settings withChannelIdentification(Boolean channelIdentification) { this.channelIdentification = channelIdentification; return this; } /** *

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

* * @return

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

*/ public Boolean isShowAlternatives() { return 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. *

* * @return

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

*/ public Boolean getShowAlternatives() { return 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. *

* * @param 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. *

*/ public void setShowAlternatives(Boolean showAlternatives) { this.showAlternatives = 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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public Settings withShowAlternatives(Boolean showAlternatives) { this.showAlternatives = showAlternatives; return this; } /** *

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

*

* Constraints:
* Range: 2 - 10
* * @return

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

*/ public Integer getMaxAlternatives() { return 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. *

*

* Constraints:
* Range: 2 - 10
* * @param 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. *

*/ public void setMaxAlternatives(Integer maxAlternatives) { this.maxAlternatives = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 2 - 10
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public Settings withMaxAlternatives(Integer maxAlternatives) { this.maxAlternatives = maxAlternatives; return this; } /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

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

*/ public String getVocabularyFilterName() { return 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

*/ public void setVocabularyFilterName(String vocabularyFilterName) { this.vocabularyFilterName = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public Settings withVocabularyFilterName(String vocabularyFilterName) { this.vocabularyFilterName = vocabularyFilterName; return this; } /** *

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

*

* Constraints:
* Allowed Values: remove, mask, tag * * @return

* 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 VocabularyFilterMethod */ public String getVocabularyFilterMethod() { return 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. *

*

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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 VocabularyFilterMethod */ public void setVocabularyFilterMethod(String vocabularyFilterMethod) { this.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. *

*

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

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyFilterMethod */ public Settings withVocabularyFilterMethod(String vocabularyFilterMethod) { this.vocabularyFilterMethod = vocabularyFilterMethod; return this; } /** *

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

*

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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 VocabularyFilterMethod */ public void setVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) { this.vocabularyFilterMethod = vocabularyFilterMethod.toString(); } /** *

* 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyFilterMethod */ public Settings withVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) { this.vocabularyFilterMethod = vocabularyFilterMethod.toString(); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getVocabularyName() != null) sb.append("VocabularyName: " + getVocabularyName() + ","); if (getShowSpeakerLabels() != null) sb.append("ShowSpeakerLabels: " + getShowSpeakerLabels() + ","); if (getMaxSpeakerLabels() != null) sb.append("MaxSpeakerLabels: " + getMaxSpeakerLabels() + ","); if (getChannelIdentification() != null) sb.append("ChannelIdentification: " + getChannelIdentification() + ","); if (getShowAlternatives() != null) sb.append("ShowAlternatives: " + getShowAlternatives() + ","); if (getMaxAlternatives() != null) sb.append("MaxAlternatives: " + getMaxAlternatives() + ","); if (getVocabularyFilterName() != null) sb.append("VocabularyFilterName: " + getVocabularyFilterName() + ","); if (getVocabularyFilterMethod() != null) sb.append("VocabularyFilterMethod: " + getVocabularyFilterMethod()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getVocabularyName() == null) ? 0 : getVocabularyName().hashCode()); hashCode = prime * hashCode + ((getShowSpeakerLabels() == null) ? 0 : getShowSpeakerLabels().hashCode()); hashCode = prime * hashCode + ((getMaxSpeakerLabels() == null) ? 0 : getMaxSpeakerLabels().hashCode()); hashCode = prime * hashCode + ((getChannelIdentification() == null) ? 0 : getChannelIdentification().hashCode()); hashCode = prime * hashCode + ((getShowAlternatives() == null) ? 0 : getShowAlternatives().hashCode()); hashCode = prime * hashCode + ((getMaxAlternatives() == null) ? 0 : getMaxAlternatives().hashCode()); hashCode = prime * hashCode + ((getVocabularyFilterName() == null) ? 0 : getVocabularyFilterName().hashCode()); hashCode = prime * hashCode + ((getVocabularyFilterMethod() == null) ? 0 : getVocabularyFilterMethod() .hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof Settings == false) return false; Settings other = (Settings) obj; if (other.getVocabularyName() == null ^ this.getVocabularyName() == null) return false; if (other.getVocabularyName() != null && other.getVocabularyName().equals(this.getVocabularyName()) == false) return false; if (other.getShowSpeakerLabels() == null ^ this.getShowSpeakerLabels() == null) return false; if (other.getShowSpeakerLabels() != null && other.getShowSpeakerLabels().equals(this.getShowSpeakerLabels()) == false) return false; if (other.getMaxSpeakerLabels() == null ^ this.getMaxSpeakerLabels() == null) return false; if (other.getMaxSpeakerLabels() != null && other.getMaxSpeakerLabels().equals(this.getMaxSpeakerLabels()) == false) return false; if (other.getChannelIdentification() == null ^ this.getChannelIdentification() == null) return false; if (other.getChannelIdentification() != null && other.getChannelIdentification().equals(this.getChannelIdentification()) == false) return false; if (other.getShowAlternatives() == null ^ this.getShowAlternatives() == null) return false; if (other.getShowAlternatives() != null && other.getShowAlternatives().equals(this.getShowAlternatives()) == false) return false; if (other.getMaxAlternatives() == null ^ this.getMaxAlternatives() == null) return false; if (other.getMaxAlternatives() != null && other.getMaxAlternatives().equals(this.getMaxAlternatives()) == false) return false; if (other.getVocabularyFilterName() == null ^ this.getVocabularyFilterName() == null) return false; if (other.getVocabularyFilterName() != null && other.getVocabularyFilterName().equals(this.getVocabularyFilterName()) == false) return false; if (other.getVocabularyFilterMethod() == null ^ this.getVocabularyFilterMethod() == null) return false; if (other.getVocabularyFilterMethod() != null && other.getVocabularyFilterMethod().equals(this.getVocabularyFilterMethod()) == false) return false; return true; } }