Class SynthesisInput.Builder (2.35.0)
2.92.0 (latest)
2.89.0
2.88.0
2.86.0
2.84.0
2.83.0
2.81.0
2.79.0
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 SynthesisInput . Builder extends GeneratedMessageV3 . Builder<SynthesisInput . Builder > implements SynthesisInputOrBuilder
Contains text input to be synthesized. Either text or ssml must be
supplied. Supplying both or neither returns
google.rpc.Code.INVALID_ARGUMENT . The
input size is limited to 5000 bytes.
Protobuf type google.cloud.texttospeech.v1.SynthesisInput
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SynthesisInput . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public SynthesisInput build ()
buildPartial()
public SynthesisInput buildPartial ()
clear()
public SynthesisInput . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public SynthesisInput . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearInputSource()
public SynthesisInput . Builder clearInputSource ()
clearOneof(Descriptors.OneofDescriptor oneof)
public SynthesisInput . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
public SynthesisInput . Builder clearSsml ()
The SSML document to be synthesized. The SSML document must be valid
and well-formed. Otherwise the RPC will fail and return
google.rpc.Code.INVALID_ARGUMENT . For
more information, see
SSML .
string ssml = 2;
clearText()
public SynthesisInput . Builder clearText ()
The raw text to be synthesized.
string text = 1;
clone()
public SynthesisInput . Builder clone ()
Overrides
getDefaultInstanceForType()
public SynthesisInput getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getInputSourceCase()
public SynthesisInput . InputSourceCase getInputSourceCase ()
getSsml()
The SSML document to be synthesized. The SSML document must be valid
and well-formed. Otherwise the RPC will fail and return
google.rpc.Code.INVALID_ARGUMENT . For
more information, see
SSML .
string ssml = 2;
Returns
Type
Description
String
The ssml.
getSsmlBytes()
public ByteString getSsmlBytes ()
The SSML document to be synthesized. The SSML document must be valid
and well-formed. Otherwise the RPC will fail and return
google.rpc.Code.INVALID_ARGUMENT . For
more information, see
SSML .
string ssml = 2;
Returns
Type
Description
ByteString
The bytes for ssml.
getText()
The raw text to be synthesized.
string text = 1;
Returns
Type
Description
String
The text.
getTextBytes()
public ByteString getTextBytes ()
The raw text to be synthesized.
string text = 1;
Returns
Type
Description
ByteString
The bytes for text.
hasSsml()
The SSML document to be synthesized. The SSML document must be valid
and well-formed. Otherwise the RPC will fail and return
google.rpc.Code.INVALID_ARGUMENT . For
more information, see
SSML .
string ssml = 2;
Returns
Type
Description
boolean
Whether the ssml field is set.
hasText()
The raw text to be synthesized.
string text = 1;
Returns
Type
Description
boolean
Whether the text field is set.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(SynthesisInput other)
public SynthesisInput . Builder mergeFrom ( SynthesisInput other )
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SynthesisInput . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public SynthesisInput . Builder mergeFrom ( Message other )
Parameter
Name
Description
other
Message
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SynthesisInput . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public SynthesisInput . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SynthesisInput . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setSsml(String value)
public SynthesisInput . Builder setSsml ( String value )
The SSML document to be synthesized. The SSML document must be valid
and well-formed. Otherwise the RPC will fail and return
google.rpc.Code.INVALID_ARGUMENT . For
more information, see
SSML .
string ssml = 2;
Parameter
Name
Description
value
String The ssml to set.
setSsmlBytes(ByteString value)
public SynthesisInput . Builder setSsmlBytes ( ByteString value )
The SSML document to be synthesized. The SSML document must be valid
and well-formed. Otherwise the RPC will fail and return
google.rpc.Code.INVALID_ARGUMENT . For
more information, see
SSML .
string ssml = 2;
Parameter
Name
Description
value
ByteString The bytes for ssml to set.
setText(String value)
public SynthesisInput . Builder setText ( String value )
The raw text to be synthesized.
string text = 1;
Parameter
Name
Description
value
String The text to set.
setTextBytes(ByteString value)
public SynthesisInput . Builder setTextBytes ( ByteString value )
The raw text to be synthesized.
string text = 1;
Parameter
Name
Description
value
ByteString The bytes for text to set.
setUnknownFields(UnknownFieldSet unknownFields)
public final SynthesisInput . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-04-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-04-26 UTC."],[],[]]