Class Voice.Builder (2.46.0)

public static final class Voice.Builder extends GeneratedMessageV3.Builder<Voice.Builder> implements VoiceOrBuilder

Description of a voice supported by the TTS service.

Protobuf type google.cloud.texttospeech.v1.Voice

Implements

VoiceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllLanguageCodes(Iterable<String> values)

public Voice.Builder addAllLanguageCodes(Iterable<String> values)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameter
Name Description
values Iterable<String>

The languageCodes to add.

Returns
Type Description
Voice.Builder

This builder for chaining.

addLanguageCodes(String value)

public Voice.Builder addLanguageCodes(String value)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameter
Name Description
value String

The languageCodes to add.

Returns
Type Description
Voice.Builder

This builder for chaining.

addLanguageCodesBytes(ByteString value)

public Voice.Builder addLanguageCodesBytes(ByteString value)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameter
Name Description
value ByteString

The bytes of the languageCodes to add.

Returns
Type Description
Voice.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Voice.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Voice.Builder
Overrides

build()

public Voice build()
Returns
Type Description
Voice

buildPartial()

public Voice buildPartial()
Returns
Type Description
Voice

clear()

public Voice.Builder clear()
Returns
Type Description
Voice.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Voice.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Voice.Builder
Overrides

clearLanguageCodes()

public Voice.Builder clearLanguageCodes()

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Returns
Type Description
Voice.Builder

This builder for chaining.

clearName()

public Voice.Builder clearName()

The name of this voice. Each distinct voice has a unique name.

string name = 2;

Returns
Type Description
Voice.Builder

This builder for chaining.

clearNaturalSampleRateHertz()

public Voice.Builder clearNaturalSampleRateHertz()

The natural sample rate (in hertz) for this voice.

int32 natural_sample_rate_hertz = 4;

Returns
Type Description
Voice.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Voice.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Voice.Builder
Overrides

clearSsmlGender()

public Voice.Builder clearSsmlGender()

The gender of this voice.

.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;

Returns
Type Description
Voice.Builder

This builder for chaining.

clone()

public Voice.Builder clone()
Returns
Type Description
Voice.Builder
Overrides

getDefaultInstanceForType()

public Voice getDefaultInstanceForType()
Returns
Type Description
Voice

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLanguageCodes(int index)

public String getLanguageCodes(int index)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The languageCodes at the given index.

getLanguageCodesBytes(int index)

public ByteString getLanguageCodesBytes(int index)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the languageCodes at the given index.

getLanguageCodesCount()

public int getLanguageCodesCount()

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Returns
Type Description
int

The count of languageCodes.

getLanguageCodesList()

public ProtocolStringList getLanguageCodesList()

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Returns
Type Description
ProtocolStringList

A list containing the languageCodes.

getName()

public String getName()

The name of this voice. Each distinct voice has a unique name.

string name = 2;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this voice. Each distinct voice has a unique name.

string name = 2;

Returns
Type Description
ByteString

The bytes for name.

getNaturalSampleRateHertz()

public int getNaturalSampleRateHertz()

The natural sample rate (in hertz) for this voice.

int32 natural_sample_rate_hertz = 4;

Returns
Type Description
int

The naturalSampleRateHertz.

getSsmlGender()

public SsmlVoiceGender getSsmlGender()

The gender of this voice.

.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;

Returns
Type Description
SsmlVoiceGender

The ssmlGender.

getSsmlGenderValue()

public int getSsmlGenderValue()

The gender of this voice.

.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;

Returns
Type Description
int

The enum numeric value on the wire for ssmlGender.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Voice other)

public Voice.Builder mergeFrom(Voice other)
Parameter
Name Description
other Voice
Returns
Type Description
Voice.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Voice.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Voice.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Voice.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Voice.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Voice.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Voice.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Voice.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Voice.Builder
Overrides

setLanguageCodes(int index, String value)

public Voice.Builder setLanguageCodes(int index, String value)

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

repeated string language_codes = 1;

Parameters
Name Description
index int

The index to set the value at.

value String

The languageCodes to set.

Returns
Type Description
Voice.Builder

This builder for chaining.

setName(String value)

public Voice.Builder setName(String value)

The name of this voice. Each distinct voice has a unique name.

string name = 2;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Voice.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Voice.Builder setNameBytes(ByteString value)

The name of this voice. Each distinct voice has a unique name.

string name = 2;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Voice.Builder

This builder for chaining.

setNaturalSampleRateHertz(int value)

public Voice.Builder setNaturalSampleRateHertz(int value)

The natural sample rate (in hertz) for this voice.

int32 natural_sample_rate_hertz = 4;

Parameter
Name Description
value int

The naturalSampleRateHertz to set.

Returns
Type Description
Voice.Builder

This builder for chaining.

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

public Voice.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Voice.Builder
Overrides

setSsmlGender(SsmlVoiceGender value)

public Voice.Builder setSsmlGender(SsmlVoiceGender value)

The gender of this voice.

.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;

Parameter
Name Description
value SsmlVoiceGender

The ssmlGender to set.

Returns
Type Description
Voice.Builder

This builder for chaining.

setSsmlGenderValue(int value)

public Voice.Builder setSsmlGenderValue(int value)

The gender of this voice.

.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for ssmlGender to set.

Returns
Type Description
Voice.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Voice.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Voice.Builder
Overrides