Class Voice.Builder (2.17.0)

Version 2.17.0

• 2.42.0 (latest)
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.9
• 2.3.0
• 2.2.1
• 2.1.5

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Voice.Builder

Implements

VoiceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Voice.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Voice.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Voice getDefaultInstanceForType()

Returns
Type	Description
Voice

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Voice.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Voice.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Voice.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Voice.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)