Package com.google.cloud.texttospeech.v1

Class SynthesisInput.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SynthesisInput.Builder>
com.google.cloud.texttospeech.v1.SynthesisInput.Builder
All Implemented Interfaces:
SynthesisInputOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SynthesisInput
public static final class SynthesisInput.Builder extends com.google.protobuf.GeneratedMessage.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][google.rpc.Code.INVALID_ARGUMENT]. The
 input size is limited to 5000 bytes.
Protobuf type google.cloud.texttospeech.v1.SynthesisInput

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SynthesisInput.Builder>

    • clear

      public SynthesisInput.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SynthesisInput.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SynthesisInput.Builder>

    • getDefaultInstanceForType

      public SynthesisInput getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SynthesisInput build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SynthesisInput buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SynthesisInput.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SynthesisInput.Builder>

    • mergeFrom

      public SynthesisInput.Builder mergeFrom(SynthesisInput other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SynthesisInput.Builder>

    • mergeFrom

      public SynthesisInput.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SynthesisInput.Builder>
      Throws:
      IOException

    • getInputSourceCase

      public SynthesisInput.InputSourceCase getInputSourceCase()
      Specified by:
      getInputSourceCase in interface SynthesisInputOrBuilder

    • clearInputSource

      public SynthesisInput.Builder clearInputSource()

    • hasText

      public boolean hasText()
       The raw text to be synthesized.
      string text = 1;
      Specified by:
      hasText in interface SynthesisInputOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       The raw text to be synthesized.
      string text = 1;
      Specified by:
      getText in interface SynthesisInputOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       The raw text to be synthesized.
      string text = 1;
      Specified by:
      getTextBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for text.

    • setText

      public SynthesisInput.Builder setText(String value)
       The raw text to be synthesized.
      string text = 1;
      Parameters:
      value - The text to set.
      Returns:
      This builder for chaining.

    • clearText

      public SynthesisInput.Builder clearText()
       The raw text to be synthesized.
      string text = 1;
      Returns:
      This builder for chaining.

    • setTextBytes

      public SynthesisInput.Builder setTextBytes(com.google.protobuf.ByteString value)
       The raw text to be synthesized.
      string text = 1;
      Parameters:
      value - The bytes for text to set.
      Returns:
      This builder for chaining.

    • hasMarkup

      public boolean hasMarkup()
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Specified by:
      hasMarkup in interface SynthesisInputOrBuilder
      Returns:
      Whether the markup field is set.

    • getMarkup

      public String getMarkup()
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Specified by:
      getMarkup in interface SynthesisInputOrBuilder
      Returns:
      The markup.

    • getMarkupBytes

      public com.google.protobuf.ByteString getMarkupBytes()
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Specified by:
      getMarkupBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for markup.

    • setMarkup

      public SynthesisInput.Builder setMarkup(String value)
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Parameters:
      value - The markup to set.
      Returns:
      This builder for chaining.

    • clearMarkup

      public SynthesisInput.Builder clearMarkup()
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Returns:
      This builder for chaining.

    • setMarkupBytes

      public SynthesisInput.Builder setMarkupBytes(com.google.protobuf.ByteString value)
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Parameters:
      value - The bytes for markup to set.
      Returns:
      This builder for chaining.

    • 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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Specified by:
      hasSsml in interface SynthesisInputOrBuilder
      Returns:
      Whether the ssml field is set.

    • 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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Specified by:
      getSsml in interface SynthesisInputOrBuilder
      Returns:
      The ssml.

    • getSsmlBytes

      public com.google.protobuf.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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Specified by:
      getSsmlBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for ssml.

    • setSsml

      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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Parameters:
      value - The ssml to set.
      Returns:
      This builder for chaining.

    • 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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Returns:
      This builder for chaining.

    • setSsmlBytes

      public SynthesisInput.Builder setSsmlBytes(com.google.protobuf.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][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Parameters:
      value - The bytes for ssml to set.
      Returns:
      This builder for chaining.

    • hasMultiSpeakerMarkup

      public boolean hasMultiSpeakerMarkup()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
      Specified by:
      hasMultiSpeakerMarkup in interface SynthesisInputOrBuilder
      Returns:
      Whether the multiSpeakerMarkup field is set.

    • getMultiSpeakerMarkup

      public MultiSpeakerMarkup getMultiSpeakerMarkup()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
      Specified by:
      getMultiSpeakerMarkup in interface SynthesisInputOrBuilder
      Returns:
      The multiSpeakerMarkup.

    • setMultiSpeakerMarkup

      public SynthesisInput.Builder setMultiSpeakerMarkup(MultiSpeakerMarkup value)
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;

    • setMultiSpeakerMarkup

      public SynthesisInput.Builder setMultiSpeakerMarkup(MultiSpeakerMarkup.Builder builderForValue)
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;

    • mergeMultiSpeakerMarkup

      public SynthesisInput.Builder mergeMultiSpeakerMarkup(MultiSpeakerMarkup value)
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;

    • clearMultiSpeakerMarkup

      public SynthesisInput.Builder clearMultiSpeakerMarkup()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;

    • getMultiSpeakerMarkupBuilder

      public MultiSpeakerMarkup.Builder getMultiSpeakerMarkupBuilder()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;

    • getMultiSpeakerMarkupOrBuilder

      public MultiSpeakerMarkupOrBuilder getMultiSpeakerMarkupOrBuilder()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
      Specified by:
      getMultiSpeakerMarkupOrBuilder in interface SynthesisInputOrBuilder

    • hasPrompt

      public boolean hasPrompt()
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Specified by:
      hasPrompt in interface SynthesisInputOrBuilder
      Returns:
      Whether the prompt field is set.

    • getPrompt

      public String getPrompt()
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Specified by:
      getPrompt in interface SynthesisInputOrBuilder
      Returns:
      The prompt.

    • getPromptBytes

      public com.google.protobuf.ByteString getPromptBytes()
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Specified by:
      getPromptBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for prompt.

    • setPrompt

      public SynthesisInput.Builder setPrompt(String value)
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Parameters:
      value - The prompt to set.
      Returns:
      This builder for chaining.

    • clearPrompt

      public SynthesisInput.Builder clearPrompt()
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Returns:
      This builder for chaining.

    • setPromptBytes

      public SynthesisInput.Builder setPromptBytes(com.google.protobuf.ByteString value)
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Parameters:
      value - The bytes for prompt to set.
      Returns:
      This builder for chaining.

    • hasCustomPronunciations

      public boolean hasCustomPronunciations()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomPronunciations in interface SynthesisInputOrBuilder
      Returns:
      Whether the customPronunciations field is set.

    • getCustomPronunciations

      public CustomPronunciations getCustomPronunciations()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomPronunciations in interface SynthesisInputOrBuilder
      Returns:
      The customPronunciations.

    • setCustomPronunciations

      public SynthesisInput.Builder setCustomPronunciations(CustomPronunciations value)
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

    • setCustomPronunciations

      public SynthesisInput.Builder setCustomPronunciations(CustomPronunciations.Builder builderForValue)
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

    • mergeCustomPronunciations

      public SynthesisInput.Builder mergeCustomPronunciations(CustomPronunciations value)
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

    • clearCustomPronunciations

      public SynthesisInput.Builder clearCustomPronunciations()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getCustomPronunciationsBuilder

      public CustomPronunciations.Builder getCustomPronunciationsBuilder()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getCustomPronunciationsOrBuilder

      public CustomPronunciationsOrBuilder getCustomPronunciationsOrBuilder()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomPronunciationsOrBuilder in interface SynthesisInputOrBuilder