- 2.79.0 (latest)
 - 2.77.0
 - 2.76.0
 - 2.75.0
 - 2.74.0
 - 2.73.0
 - 2.71.0
 - 2.69.0
 - 2.68.0
 - 2.65.0
 - 2.64.0
 - 2.63.0
 - 2.61.0
 - 2.60.0
 - 2.59.0
 - 2.58.0
 - 2.57.0
 - 2.56.0
 - 2.55.0
 - 2.54.0
 - 2.53.0
 - 2.52.0
 - 2.50.0
 - 2.49.0
 - 2.48.0
 - 2.47.0
 - 2.46.0
 - 2.45.0
 - 2.44.0
 - 2.43.0
 - 2.42.0
 - 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 SynthesizeSpeechRequest.Builder extends GeneratedMessageV3.Builder<SynthesizeSpeechRequest.Builder> implements SynthesizeSpeechRequestOrBuilder The top-level message sent by the client for the SynthesizeSpeech method.
 Protobuf type google.cloud.texttospeech.v1.SynthesizeSpeechRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SynthesizeSpeechRequest.BuilderImplements
SynthesizeSpeechRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SynthesizeSpeechRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
build()
public SynthesizeSpeechRequest build()| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest | 
        |
buildPartial()
public SynthesizeSpeechRequest buildPartial()| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest | 
        |
clear()
public SynthesizeSpeechRequest.Builder clear()| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
clearAdvancedVoiceOptions()
public SynthesizeSpeechRequest.Builder clearAdvancedVoiceOptions()Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
clearAudioConfig()
public SynthesizeSpeechRequest.Builder clearAudioConfig()Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
clearField(Descriptors.FieldDescriptor field)
public SynthesizeSpeechRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
clearInput()
public SynthesizeSpeechRequest.Builder clearInput()Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
clearOneof(Descriptors.OneofDescriptor oneof)
public SynthesizeSpeechRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
clearVoice()
public SynthesizeSpeechRequest.Builder clearVoice()Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
clone()
public SynthesizeSpeechRequest.Builder clone()| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
getAdvancedVoiceOptions()
public AdvancedVoiceOptions getAdvancedVoiceOptions()Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Returns | |
|---|---|
| Type | Description | 
AdvancedVoiceOptions | 
        The advancedVoiceOptions.  | 
      
getAdvancedVoiceOptionsBuilder()
public AdvancedVoiceOptions.Builder getAdvancedVoiceOptionsBuilder()Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Returns | |
|---|---|
| Type | Description | 
AdvancedVoiceOptions.Builder | 
        |
getAdvancedVoiceOptionsOrBuilder()
public AdvancedVoiceOptionsOrBuilder getAdvancedVoiceOptionsOrBuilder()Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Returns | |
|---|---|
| Type | Description | 
AdvancedVoiceOptionsOrBuilder | 
        |
getAudioConfig()
public AudioConfig getAudioConfig()Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
AudioConfig | 
        The audioConfig.  | 
      
getAudioConfigBuilder()
public AudioConfig.Builder getAudioConfigBuilder()Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
AudioConfig.Builder | 
        |
getAudioConfigOrBuilder()
public AudioConfigOrBuilder getAudioConfigOrBuilder()Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
AudioConfigOrBuilder | 
        |
getDefaultInstanceForType()
public SynthesizeSpeechRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getInput()
public SynthesisInput getInput()Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
SynthesisInput | 
        The input.  | 
      
getInputBuilder()
public SynthesisInput.Builder getInputBuilder()Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
SynthesisInput.Builder | 
        |
getInputOrBuilder()
public SynthesisInputOrBuilder getInputOrBuilder()Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
SynthesisInputOrBuilder | 
        |
getVoice()
public VoiceSelectionParams getVoice()Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
VoiceSelectionParams | 
        The voice.  | 
      
getVoiceBuilder()
public VoiceSelectionParams.Builder getVoiceBuilder()Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
VoiceSelectionParams.Builder | 
        |
getVoiceOrBuilder()
public VoiceSelectionParamsOrBuilder getVoiceOrBuilder()Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
VoiceSelectionParamsOrBuilder | 
        |
hasAdvancedVoiceOptions()
public boolean hasAdvancedVoiceOptions()Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the advancedVoiceOptions field is set.  | 
      
hasAudioConfig()
public boolean hasAudioConfig()Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the audioConfig field is set.  | 
      
hasInput()
public boolean hasInput()Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the input field is set.  | 
      
hasVoice()
public boolean hasVoice()Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the voice field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeAdvancedVoiceOptions(AdvancedVoiceOptions value)
public SynthesizeSpeechRequest.Builder mergeAdvancedVoiceOptions(AdvancedVoiceOptions value)Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        AdvancedVoiceOptions | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
mergeAudioConfig(AudioConfig value)
public SynthesizeSpeechRequest.Builder mergeAudioConfig(AudioConfig value)Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        AudioConfig | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
mergeFrom(SynthesizeSpeechRequest other)
public SynthesizeSpeechRequest.Builder mergeFrom(SynthesizeSpeechRequest other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        SynthesizeSpeechRequest | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SynthesizeSpeechRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public SynthesizeSpeechRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
mergeInput(SynthesisInput value)
public SynthesizeSpeechRequest.Builder mergeInput(SynthesisInput value)Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        SynthesisInput | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SynthesizeSpeechRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
mergeVoice(VoiceSelectionParams value)
public SynthesizeSpeechRequest.Builder mergeVoice(VoiceSelectionParams value)Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        VoiceSelectionParams | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setAdvancedVoiceOptions(AdvancedVoiceOptions value)
public SynthesizeSpeechRequest.Builder setAdvancedVoiceOptions(AdvancedVoiceOptions value)Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        AdvancedVoiceOptions | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setAdvancedVoiceOptions(AdvancedVoiceOptions.Builder builderForValue)
public SynthesizeSpeechRequest.Builder setAdvancedVoiceOptions(AdvancedVoiceOptions.Builder builderForValue)Advanced voice options.
 optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        AdvancedVoiceOptions.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setAudioConfig(AudioConfig value)
public SynthesizeSpeechRequest.Builder setAudioConfig(AudioConfig value)Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        AudioConfig | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setAudioConfig(AudioConfig.Builder builderForValue)
public SynthesizeSpeechRequest.Builder setAudioConfig(AudioConfig.Builder builderForValue)Required. The configuration of the synthesized audio.
 
 .google.cloud.texttospeech.v1.AudioConfig audio_config = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        AudioConfig.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setField(Descriptors.FieldDescriptor field, Object value)
public SynthesizeSpeechRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setInput(SynthesisInput value)
public SynthesizeSpeechRequest.Builder setInput(SynthesisInput value)Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        SynthesisInput | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setInput(SynthesisInput.Builder builderForValue)
public SynthesizeSpeechRequest.Builder setInput(SynthesisInput.Builder builderForValue)Required. The Synthesizer requires either plain text or SSML as input.
 
 .google.cloud.texttospeech.v1.SynthesisInput input = 1 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        SynthesisInput.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SynthesizeSpeechRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final SynthesizeSpeechRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setVoice(VoiceSelectionParams value)
public SynthesizeSpeechRequest.Builder setVoice(VoiceSelectionParams value)Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
value | 
        VoiceSelectionParams | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |
setVoice(VoiceSelectionParams.Builder builderForValue)
public SynthesizeSpeechRequest.Builder setVoice(VoiceSelectionParams.Builder builderForValue)Required. The desired voice of the synthesized audio.
 
 .google.cloud.texttospeech.v1.VoiceSelectionParams voice = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        VoiceSelectionParams.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
SynthesizeSpeechRequest.Builder | 
        |