Class SynthesisInput (2.3.0)
2.89.0 (latest)
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 final class SynthesisInput extends GeneratedMessageV3 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
characters.
Protobuf type google.cloud.texttospeech.v1.SynthesisInput
Static Fields
SSML_FIELD_NUMBER
public static final int SSML_FIELD_NUMBER
Field Value
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SynthesisInput getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static SynthesisInput . Builder newBuilder ()
Returns
newBuilder(SynthesisInput prototype)
public static SynthesisInput . Builder newBuilder ( SynthesisInput prototype )
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static SynthesisInput parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SynthesisInput parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SynthesisInput parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static SynthesisInput parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static SynthesisInput parseFrom ( InputStream input )
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SynthesisInput parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SynthesisInput parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<SynthesisInput> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SynthesisInput getDefaultInstanceForType ()
Returns
getInputSourceCase()
public SynthesisInput . InputSourceCase getInputSourceCase ()
Returns
getParserForType()
public Parser<SynthesisInput> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
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
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public SynthesisInput . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SynthesisInput . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public SynthesisInput . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-03-30 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-03-30 UTC."],[],[]]
