VoiceSelectionParams.Builder (Google Cloud Text-to-Speech Parent 2.4.9 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>
    - - com.google.cloud.texttospeech.v1beta1.VoiceSelectionParams.Builder

All Implemented Interfaces:

VoiceSelectionParamsOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:

VoiceSelectionParams
```
public static final class VoiceSelectionParams.Builder
extends GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>
implements VoiceSelectionParamsOrBuilder
```
```
 Description of which voice to use for a synthesis request.
 
```
Protobuf type google.cloud.texttospeech.v1beta1.VoiceSelectionParams

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VoiceSelectionParams.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)`
`VoiceSelectionParams`	`build()`
`VoiceSelectionParams`	`buildPartial()`
`VoiceSelectionParams.Builder`	`clear()`
`VoiceSelectionParams.Builder`	`clearCustomVoice()` The configuration for a custom voice.
`VoiceSelectionParams.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`VoiceSelectionParams.Builder`	`clearLanguageCode()` Required.
`VoiceSelectionParams.Builder`	`clearName()` The name of the voice.
`VoiceSelectionParams.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`VoiceSelectionParams.Builder`	`clearSsmlGender()` The preferred gender of the voice.
`VoiceSelectionParams.Builder`	`clone()`
`CustomVoiceParams`	`getCustomVoice()` The configuration for a custom voice.
`CustomVoiceParams.Builder`	`getCustomVoiceBuilder()` The configuration for a custom voice.
`CustomVoiceParamsOrBuilder`	`getCustomVoiceOrBuilder()` The configuration for a custom voice.
`VoiceSelectionParams`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getLanguageCode()` Required.
`ByteString`	`getLanguageCodeBytes()` Required.
`String`	`getName()` The name of the voice.
`ByteString`	`getNameBytes()` The name of the voice.
`SsmlVoiceGender`	`getSsmlGender()` The preferred gender of the voice.
`int`	`getSsmlGenderValue()` The preferred gender of the voice.
`boolean`	`hasCustomVoice()` The configuration for a custom voice.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`VoiceSelectionParams.Builder`	`mergeCustomVoice(CustomVoiceParams value)` The configuration for a custom voice.
`VoiceSelectionParams.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`VoiceSelectionParams.Builder`	`mergeFrom(Message other)`
`VoiceSelectionParams.Builder`	`mergeFrom(VoiceSelectionParams other)`
`VoiceSelectionParams.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`VoiceSelectionParams.Builder`	`setCustomVoice(CustomVoiceParams.Builder builderForValue)` The configuration for a custom voice.
`VoiceSelectionParams.Builder`	`setCustomVoice(CustomVoiceParams value)` The configuration for a custom voice.
`VoiceSelectionParams.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)`
`VoiceSelectionParams.Builder`	`setLanguageCode(String value)` Required.
`VoiceSelectionParams.Builder`	`setLanguageCodeBytes(ByteString value)` Required.
`VoiceSelectionParams.Builder`	`setName(String value)` The name of the voice.
`VoiceSelectionParams.Builder`	`setNameBytes(ByteString value)` The name of the voice.
`VoiceSelectionParams.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)`
`VoiceSelectionParams.Builder`	`setSsmlGender(SsmlVoiceGender value)` The preferred gender of the voice.
`VoiceSelectionParams.Builder`	`setSsmlGenderValue(int value)` The preferred gender of the voice.
`VoiceSelectionParams.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

clear
```
public VoiceSelectionParams.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

getDefaultInstanceForType
```
public VoiceSelectionParams getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public VoiceSelectionParams build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public VoiceSelectionParams buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public VoiceSelectionParams.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

setField

public VoiceSelectionParams.Builder setField(Descriptors.FieldDescriptor field,
                                             Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

clearField
```
public VoiceSelectionParams.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

clearOneof
```
public VoiceSelectionParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

setRepeatedField

public VoiceSelectionParams.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

addRepeatedField

public VoiceSelectionParams.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                     Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

mergeFrom
```
public VoiceSelectionParams.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<VoiceSelectionParams.Builder>

mergeFrom

public VoiceSelectionParams.Builder mergeFrom(VoiceSelectionParams other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<VoiceSelectionParams.Builder>

mergeFrom

public VoiceSelectionParams.Builder mergeFrom(CodedInputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class 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 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(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 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(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.