Class SynthesisInput.Builder (2.7.0)

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 characters.

Protobuf type google.cloud.texttospeech.v1.SynthesisInput

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SynthesisInput.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SynthesisInput.Builder
Overrides

build()

public SynthesisInput build()
Returns
TypeDescription
SynthesisInput

buildPartial()

public SynthesisInput buildPartial()
Returns
TypeDescription
SynthesisInput

clear()

public SynthesisInput.Builder clear()
Returns
TypeDescription
SynthesisInput.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SynthesisInput.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SynthesisInput.Builder
Overrides

clearInputSource()

public SynthesisInput.Builder clearInputSource()
Returns
TypeDescription
SynthesisInput.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SynthesisInput.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SynthesisInput.Builder
Overrides

clearSsml()

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;

Returns
TypeDescription
SynthesisInput.Builder

This builder for chaining.

clearText()

public SynthesisInput.Builder clearText()

The raw text to be synthesized.

string text = 1;

Returns
TypeDescription
SynthesisInput.Builder

This builder for chaining.

clone()

public SynthesisInput.Builder clone()
Returns
TypeDescription
SynthesisInput.Builder
Overrides

getDefaultInstanceForType()

public SynthesisInput getDefaultInstanceForType()
Returns
TypeDescription
SynthesisInput

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getInputSourceCase()

public SynthesisInput.InputSourceCase getInputSourceCase()
Returns
TypeDescription
SynthesisInput.InputSourceCase

getSsml()

public String 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
TypeDescription
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
TypeDescription
ByteString

The bytes for ssml.

getText()

public String getText()

The raw text to be synthesized.

string text = 1;

Returns
TypeDescription
String

The text.

getTextBytes()

public ByteString getTextBytes()

The raw text to be synthesized.

string text = 1;

Returns
TypeDescription
ByteString

The bytes for text.

hasSsml()

public boolean 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
TypeDescription
boolean

Whether the ssml field is set.

hasText()

public boolean hasText()

The raw text to be synthesized.

string text = 1;

Returns
TypeDescription
boolean

Whether the text field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SynthesisInput other)

public SynthesisInput.Builder mergeFrom(SynthesisInput other)
Parameter
NameDescription
otherSynthesisInput
Returns
TypeDescription
SynthesisInput.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SynthesisInput.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesisInput.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SynthesisInput.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SynthesisInput.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SynthesisInput.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SynthesisInput.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SynthesisInput.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SynthesisInput.Builder
Overrides

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

public SynthesisInput.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SynthesisInput.Builder
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
NameDescription
valueString

The ssml to set.

Returns
TypeDescription
SynthesisInput.Builder

This builder for chaining.

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
NameDescription
valueByteString

The bytes for ssml to set.

Returns
TypeDescription
SynthesisInput.Builder

This builder for chaining.

setText(String value)

public SynthesisInput.Builder setText(String value)

The raw text to be synthesized.

string text = 1;

Parameter
NameDescription
valueString

The text to set.

Returns
TypeDescription
SynthesisInput.Builder

This builder for chaining.

setTextBytes(ByteString value)

public SynthesisInput.Builder setTextBytes(ByteString value)

The raw text to be synthesized.

string text = 1;

Parameter
NameDescription
valueByteString

The bytes for text to set.

Returns
TypeDescription
SynthesisInput.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SynthesisInput.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SynthesisInput.Builder
Overrides