Class SynthesizeSpeechRequest (2.54.0)

Version latest

• 2.54.0 (latest)
• 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 SynthesizeSpeechRequest extends GeneratedMessageV3 implements SynthesizeSpeechRequestOrBuilder

The top-level message sent by the client for the SynthesizeSpeech method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeSpeechRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SynthesizeSpeechRequest

Implements

SynthesizeSpeechRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ADVANCED_VOICE_OPTIONS_FIELD_NUMBER

public static final int ADVANCED_VOICE_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

AUDIO_CONFIG_FIELD_NUMBER

public static final int AUDIO_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

INPUT_FIELD_NUMBER

public static final int INPUT_FIELD_NUMBER

Field Value
Type	Description
int

VOICE_FIELD_NUMBER

public static final int VOICE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SynthesizeSpeechRequest getDefaultInstance()

Returns
Type	Description
SynthesizeSpeechRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SynthesizeSpeechRequest.Builder newBuilder()

Returns
Type	Description
SynthesizeSpeechRequest.Builder

newBuilder(SynthesizeSpeechRequest prototype)

public static SynthesizeSpeechRequest.Builder newBuilder(SynthesizeSpeechRequest prototype)

Parameter
Name	Description
prototype	SynthesizeSpeechRequest

Returns
Type	Description
SynthesizeSpeechRequest.Builder

parseDelimitedFrom(InputStream input)

public static SynthesizeSpeechRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SynthesizeSpeechRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SynthesizeSpeechRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SynthesizeSpeechRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SynthesizeSpeechRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SynthesizeSpeechRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SynthesizeSpeechRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SynthesizeSpeechRequest> parser()

Returns
Type	Description
Parser<SynthesizeSpeechRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAdvancedVoiceOptions()

public AdvancedVoiceOptions getAdvancedVoiceOptions()

Advanced voice options.

optional .google.cloud.texttospeech.v1.AdvancedVoiceOptions advanced_voice_options = 8;

Returns
Type	Description
AdvancedVoiceOptions	The advancedVoiceOptions.

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.

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

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.

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

getParserForType()

public Parser<SynthesizeSpeechRequest> getParserForType()

Returns
Type	Description
Parser<SynthesizeSpeechRequest>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SynthesizeSpeechRequest.Builder newBuilderForType()

Returns
Type	Description
SynthesizeSpeechRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SynthesizeSpeechRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SynthesizeSpeechRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SynthesizeSpeechRequest.Builder toBuilder()

Returns
Type	Description
SynthesizeSpeechRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException