Package com.google.cloud.texttospeech.v1beta1

Class VoiceSelectionParams.Builder

  • All Implemented Interfaces:
    VoiceSelectionParamsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    VoiceSelectionParams
    public static final class VoiceSelectionParams.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>
implements VoiceSelectionParamsOrBuilder
     Description of which voice to use for a synthesis request.
    Protobuf type google.cloud.texttospeech.v1beta1.VoiceSelectionParams

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • clear

        public VoiceSelectionParams.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • getDefaultInstanceForType

        public VoiceSelectionParams getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public VoiceSelectionParams build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public VoiceSelectionParams buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public VoiceSelectionParams.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • setField

        public VoiceSelectionParams.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • clearField

        public VoiceSelectionParams.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • clearOneof

        public VoiceSelectionParams.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • setRepeatedField

        public VoiceSelectionParams.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • addRepeatedField

        public VoiceSelectionParams.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • mergeFrom

        public VoiceSelectionParams.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VoiceSelectionParams.Builder>
        Throws:
        IOException

      • getLanguageCode

        public String getLanguageCode()
         Required. The language (and potentially also the region) of the voice expressed as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
 "en-US". This should not include a script tag (e.g. use
 "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
 from the input provided in the SynthesisInput.  The TTS service
 will use this parameter to help choose an appropriate voice.  Note that
 the TTS service may choose a voice with a slightly different language code
 than the one selected; it may substitute a different region
 (e.g. using en-US rather than en-CA if there isn't a Canadian voice
 available), or even a different language, e.g. using "nb" (Norwegian
 Bokmal) instead of "no" (Norwegian)".
        string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLanguageCode in interface VoiceSelectionParamsOrBuilder
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         Required. The language (and potentially also the region) of the voice expressed as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
 "en-US". This should not include a script tag (e.g. use
 "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
 from the input provided in the SynthesisInput.  The TTS service
 will use this parameter to help choose an appropriate voice.  Note that
 the TTS service may choose a voice with a slightly different language code
 than the one selected; it may substitute a different region
 (e.g. using en-US rather than en-CA if there isn't a Canadian voice
 available), or even a different language, e.g. using "nb" (Norwegian
 Bokmal) instead of "no" (Norwegian)".
        string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLanguageCodeBytes in interface VoiceSelectionParamsOrBuilder
        Returns:
        The bytes for languageCode.

      • setLanguageCode

        public VoiceSelectionParams.Builder setLanguageCode​(String value)
         Required. The language (and potentially also the region) of the voice expressed as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
 "en-US". This should not include a script tag (e.g. use
 "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
 from the input provided in the SynthesisInput.  The TTS service
 will use this parameter to help choose an appropriate voice.  Note that
 the TTS service may choose a voice with a slightly different language code
 than the one selected; it may substitute a different region
 (e.g. using en-US rather than en-CA if there isn't a Canadian voice
 available), or even a different language, e.g. using "nb" (Norwegian
 Bokmal) instead of "no" (Norwegian)".
        string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The languageCode to set.
        Returns:
        This builder for chaining.

      • clearLanguageCode

        public VoiceSelectionParams.Builder clearLanguageCode()
         Required. The language (and potentially also the region) of the voice expressed as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
 "en-US". This should not include a script tag (e.g. use
 "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
 from the input provided in the SynthesisInput.  The TTS service
 will use this parameter to help choose an appropriate voice.  Note that
 the TTS service may choose a voice with a slightly different language code
 than the one selected; it may substitute a different region
 (e.g. using en-US rather than en-CA if there isn't a Canadian voice
 available), or even a different language, e.g. using "nb" (Norwegian
 Bokmal) instead of "no" (Norwegian)".
        string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setLanguageCodeBytes

        public VoiceSelectionParams.Builder setLanguageCodeBytes​(com.google.protobuf.ByteString value)
         Required. The language (and potentially also the region) of the voice expressed as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
 "en-US". This should not include a script tag (e.g. use
 "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
 from the input provided in the SynthesisInput.  The TTS service
 will use this parameter to help choose an appropriate voice.  Note that
 the TTS service may choose a voice with a slightly different language code
 than the one selected; it may substitute a different region
 (e.g. using en-US rather than en-CA if there isn't a Canadian voice
 available), or even a different language, e.g. using "nb" (Norwegian
 Bokmal) instead of "no" (Norwegian)".
        string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for languageCode to set.
        Returns:
        This builder for chaining.

      • getName

        public String getName()
         The name of the voice. If not set, the service will choose a
 voice based on the other parameters such as language_code and gender.
        string name = 2;
        Specified by:
        getName in interface VoiceSelectionParamsOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the voice. If not set, the service will choose a
 voice based on the other parameters such as language_code and gender.
        string name = 2;
        Specified by:
        getNameBytes in interface VoiceSelectionParamsOrBuilder
        Returns:
        The bytes for name.

      • setName

        public VoiceSelectionParams.Builder setName​(String value)
         The name of the voice. If not set, the service will choose a
 voice based on the other parameters such as language_code and gender.
        string name = 2;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public VoiceSelectionParams.Builder clearName()
         The name of the voice. If not set, the service will choose a
 voice based on the other parameters such as language_code and gender.
        string name = 2;
        Returns:
        This builder for chaining.

      • setNameBytes

        public VoiceSelectionParams.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The name of the voice. If not set, the service will choose a
 voice based on the other parameters such as language_code and gender.
        string name = 2;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getSsmlGenderValue

        public int getSsmlGenderValue()
         The preferred gender of the voice. If not set, the service will
 choose a voice based on the other parameters such as language_code and
 name. Note that this is only a preference, not requirement; if a
 voice of the appropriate gender is not available, the synthesizer should
 substitute a voice with a different gender rather than failing the request.
        .google.cloud.texttospeech.v1beta1.SsmlVoiceGender ssml_gender = 3;
        Specified by:
        getSsmlGenderValue in interface VoiceSelectionParamsOrBuilder
        Returns:
        The enum numeric value on the wire for ssmlGender.

      • setSsmlGenderValue

        public VoiceSelectionParams.Builder setSsmlGenderValue​(int value)
         The preferred gender of the voice. If not set, the service will
 choose a voice based on the other parameters such as language_code and
 name. Note that this is only a preference, not requirement; if a
 voice of the appropriate gender is not available, the synthesizer should
 substitute a voice with a different gender rather than failing the request.
        .google.cloud.texttospeech.v1beta1.SsmlVoiceGender ssml_gender = 3;
        Parameters:
        value - The enum numeric value on the wire for ssmlGender to set.
        Returns:
        This builder for chaining.

      • getSsmlGender

        public SsmlVoiceGender getSsmlGender()
         The preferred gender of the voice. If not set, the service will
 choose a voice based on the other parameters such as language_code and
 name. Note that this is only a preference, not requirement; if a
 voice of the appropriate gender is not available, the synthesizer should
 substitute a voice with a different gender rather than failing the request.
        .google.cloud.texttospeech.v1beta1.SsmlVoiceGender ssml_gender = 3;
        Specified by:
        getSsmlGender in interface VoiceSelectionParamsOrBuilder
        Returns:
        The ssmlGender.

      • setSsmlGender

        public VoiceSelectionParams.Builder setSsmlGender​(SsmlVoiceGender value)
         The preferred gender of the voice. If not set, the service will
 choose a voice based on the other parameters such as language_code and
 name. Note that this is only a preference, not requirement; if a
 voice of the appropriate gender is not available, the synthesizer should
 substitute a voice with a different gender rather than failing the request.
        .google.cloud.texttospeech.v1beta1.SsmlVoiceGender ssml_gender = 3;
        Parameters:
        value - The ssmlGender to set.
        Returns:
        This builder for chaining.

      • clearSsmlGender

        public VoiceSelectionParams.Builder clearSsmlGender()
         The preferred gender of the voice. If not set, the service will
 choose a voice based on the other parameters such as language_code and
 name. Note that this is only a preference, not requirement; if a
 voice of the appropriate gender is not available, the synthesizer should
 substitute a voice with a different gender rather than failing the request.
        .google.cloud.texttospeech.v1beta1.SsmlVoiceGender ssml_gender = 3;
        Returns:
        This builder for chaining.

      • hasCustomVoice

        public boolean hasCustomVoice()
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;
        Specified by:
        hasCustomVoice in interface VoiceSelectionParamsOrBuilder
        Returns:
        Whether the customVoice field is set.

      • getCustomVoice

        public CustomVoiceParams getCustomVoice()
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;
        Specified by:
        getCustomVoice in interface VoiceSelectionParamsOrBuilder
        Returns:
        The customVoice.

      • setCustomVoice

        public VoiceSelectionParams.Builder setCustomVoice​(CustomVoiceParams value)
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;

      • setCustomVoice

        public VoiceSelectionParams.Builder setCustomVoice​(CustomVoiceParams.Builder builderForValue)
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;

      • mergeCustomVoice

        public VoiceSelectionParams.Builder mergeCustomVoice​(CustomVoiceParams value)
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;

      • clearCustomVoice

        public VoiceSelectionParams.Builder clearCustomVoice()
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;

      • getCustomVoiceBuilder

        public CustomVoiceParams.Builder getCustomVoiceBuilder()
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;

      • getCustomVoiceOrBuilder

        public CustomVoiceParamsOrBuilder getCustomVoiceOrBuilder()
         The configuration for a custom voice. If [CustomVoiceParams.model] is set,
 the service will choose the custom voice matching the specified
 configuration.
        .google.cloud.texttospeech.v1beta1.CustomVoiceParams custom_voice = 4;
        Specified by:
        getCustomVoiceOrBuilder in interface VoiceSelectionParamsOrBuilder

      • setUnknownFields

        public final VoiceSelectionParams.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

      • mergeUnknownFields

        public final VoiceSelectionParams.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>