Class StreamingRecognitionResult.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StreamingRecognitionResult.Builder>
com.google.cloud.speech.v2.StreamingRecognitionResult.Builder
All Implemented Interfaces:
StreamingRecognitionResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StreamingRecognitionResult

public static final class StreamingRecognitionResult.Builder extends com.google.protobuf.GeneratedMessage.Builder<StreamingRecognitionResult.Builder> implements StreamingRecognitionResultOrBuilder
 A streaming speech recognition result corresponding to a portion of the audio
 that is currently being processed.
 
Protobuf type google.cloud.speech.v2.StreamingRecognitionResult
  • 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<StreamingRecognitionResult.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<StreamingRecognitionResult.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<StreamingRecognitionResult.Builder>
    • getDefaultInstanceForType

      public StreamingRecognitionResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

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

      public StreamingRecognitionResult.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<StreamingRecognitionResult.Builder>
    • mergeFrom

    • isInitialized

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

      public StreamingRecognitionResult.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<StreamingRecognitionResult.Builder>
      Throws:
      IOException
    • getAlternativesList

      public List<SpeechRecognitionAlternative> getAlternativesList()
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
      Specified by:
      getAlternativesList in interface StreamingRecognitionResultOrBuilder
    • getAlternativesCount

      public int getAlternativesCount()
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
      Specified by:
      getAlternativesCount in interface StreamingRecognitionResultOrBuilder
    • getAlternatives

      public SpeechRecognitionAlternative getAlternatives(int index)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
      Specified by:
      getAlternatives in interface StreamingRecognitionResultOrBuilder
    • setAlternatives

      public StreamingRecognitionResult.Builder setAlternatives(int index, SpeechRecognitionAlternative value)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • setAlternatives

      public StreamingRecognitionResult.Builder setAlternatives(int index, SpeechRecognitionAlternative.Builder builderForValue)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • addAlternatives

       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • addAlternatives

      public StreamingRecognitionResult.Builder addAlternatives(int index, SpeechRecognitionAlternative value)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • addAlternatives

       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • addAlternatives

      public StreamingRecognitionResult.Builder addAlternatives(int index, SpeechRecognitionAlternative.Builder builderForValue)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • addAllAlternatives

      public StreamingRecognitionResult.Builder addAllAlternatives(Iterable<? extends SpeechRecognitionAlternative> values)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • clearAlternatives

      public StreamingRecognitionResult.Builder clearAlternatives()
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • removeAlternatives

      public StreamingRecognitionResult.Builder removeAlternatives(int index)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • getAlternativesBuilder

      public SpeechRecognitionAlternative.Builder getAlternativesBuilder(int index)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • getAlternativesOrBuilder

      public SpeechRecognitionAlternativeOrBuilder getAlternativesOrBuilder(int index)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
      Specified by:
      getAlternativesOrBuilder in interface StreamingRecognitionResultOrBuilder
    • getAlternativesOrBuilderList

      public List<? extends SpeechRecognitionAlternativeOrBuilder> getAlternativesOrBuilderList()
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
      Specified by:
      getAlternativesOrBuilderList in interface StreamingRecognitionResultOrBuilder
    • addAlternativesBuilder

      public SpeechRecognitionAlternative.Builder addAlternativesBuilder()
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • addAlternativesBuilder

      public SpeechRecognitionAlternative.Builder addAlternativesBuilder(int index)
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • getAlternativesBuilderList

      public List<SpeechRecognitionAlternative.Builder> getAlternativesBuilderList()
       May contain one or more recognition hypotheses. These alternatives are
       ordered in terms of accuracy, with the top (first) alternative being the
       most probable, as ranked by the recognizer.
       
      repeated .google.cloud.speech.v2.SpeechRecognitionAlternative alternatives = 1;
    • getIsFinal

      public boolean getIsFinal()
       If `false`, this
       [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult]
       represents an interim result that may change. If `true`, this is the final
       time the speech service will return this particular
       [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult],
       the recognizer will not return any further hypotheses for this portion of
       the transcript and corresponding audio.
       
      bool is_final = 2;
      Specified by:
      getIsFinal in interface StreamingRecognitionResultOrBuilder
      Returns:
      The isFinal.
    • setIsFinal

      public StreamingRecognitionResult.Builder setIsFinal(boolean value)
       If `false`, this
       [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult]
       represents an interim result that may change. If `true`, this is the final
       time the speech service will return this particular
       [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult],
       the recognizer will not return any further hypotheses for this portion of
       the transcript and corresponding audio.
       
      bool is_final = 2;
      Parameters:
      value - The isFinal to set.
      Returns:
      This builder for chaining.
    • clearIsFinal

      public StreamingRecognitionResult.Builder clearIsFinal()
       If `false`, this
       [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult]
       represents an interim result that may change. If `true`, this is the final
       time the speech service will return this particular
       [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult],
       the recognizer will not return any further hypotheses for this portion of
       the transcript and corresponding audio.
       
      bool is_final = 2;
      Returns:
      This builder for chaining.
    • getStability

      public float getStability()
       An estimate of the likelihood that the recognizer will not change its guess
       about this interim result. Values range from 0.0 (completely unstable)
       to 1.0 (completely stable). This field is only provided for interim results
       ([is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`).
       The default of 0.0 is a sentinel value indicating `stability` was not set.
       
      float stability = 3;
      Specified by:
      getStability in interface StreamingRecognitionResultOrBuilder
      Returns:
      The stability.
    • setStability

      public StreamingRecognitionResult.Builder setStability(float value)
       An estimate of the likelihood that the recognizer will not change its guess
       about this interim result. Values range from 0.0 (completely unstable)
       to 1.0 (completely stable). This field is only provided for interim results
       ([is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`).
       The default of 0.0 is a sentinel value indicating `stability` was not set.
       
      float stability = 3;
      Parameters:
      value - The stability to set.
      Returns:
      This builder for chaining.
    • clearStability

      public StreamingRecognitionResult.Builder clearStability()
       An estimate of the likelihood that the recognizer will not change its guess
       about this interim result. Values range from 0.0 (completely unstable)
       to 1.0 (completely stable). This field is only provided for interim results
       ([is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`).
       The default of 0.0 is a sentinel value indicating `stability` was not set.
       
      float stability = 3;
      Returns:
      This builder for chaining.
    • hasResultEndOffset

      public boolean hasResultEndOffset()
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
      Specified by:
      hasResultEndOffset in interface StreamingRecognitionResultOrBuilder
      Returns:
      Whether the resultEndOffset field is set.
    • getResultEndOffset

      public com.google.protobuf.Duration getResultEndOffset()
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
      Specified by:
      getResultEndOffset in interface StreamingRecognitionResultOrBuilder
      Returns:
      The resultEndOffset.
    • setResultEndOffset

      public StreamingRecognitionResult.Builder setResultEndOffset(com.google.protobuf.Duration value)
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
    • setResultEndOffset

      public StreamingRecognitionResult.Builder setResultEndOffset(com.google.protobuf.Duration.Builder builderForValue)
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
    • mergeResultEndOffset

      public StreamingRecognitionResult.Builder mergeResultEndOffset(com.google.protobuf.Duration value)
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
    • clearResultEndOffset

      public StreamingRecognitionResult.Builder clearResultEndOffset()
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
    • getResultEndOffsetBuilder

      public com.google.protobuf.Duration.Builder getResultEndOffsetBuilder()
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
    • getResultEndOffsetOrBuilder

      public com.google.protobuf.DurationOrBuilder getResultEndOffsetOrBuilder()
       Time offset of the end of this result relative to the beginning of the
       audio.
       
      .google.protobuf.Duration result_end_offset = 4;
      Specified by:
      getResultEndOffsetOrBuilder in interface StreamingRecognitionResultOrBuilder
    • getChannelTag

      public int getChannelTag()
       For multi-channel audio, this is the channel number corresponding to the
       recognized result for the audio from that channel.
       For
       `audio_channel_count` = `N`, its output values can range from `1` to `N`.
       
      int32 channel_tag = 5;
      Specified by:
      getChannelTag in interface StreamingRecognitionResultOrBuilder
      Returns:
      The channelTag.
    • setChannelTag

      public StreamingRecognitionResult.Builder setChannelTag(int value)
       For multi-channel audio, this is the channel number corresponding to the
       recognized result for the audio from that channel.
       For
       `audio_channel_count` = `N`, its output values can range from `1` to `N`.
       
      int32 channel_tag = 5;
      Parameters:
      value - The channelTag to set.
      Returns:
      This builder for chaining.
    • clearChannelTag

      public StreamingRecognitionResult.Builder clearChannelTag()
       For multi-channel audio, this is the channel number corresponding to the
       recognized result for the audio from that channel.
       For
       `audio_channel_count` = `N`, its output values can range from `1` to `N`.
       
      int32 channel_tag = 5;
      Returns:
      This builder for chaining.
    • getLanguageCode

      public String getLanguageCode()
       Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
       language tag of the language in this result. This language code was
       detected to have the most likelihood of being spoken in the audio.
       
      string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLanguageCode in interface StreamingRecognitionResultOrBuilder
      Returns:
      The languageCode.
    • getLanguageCodeBytes

      public com.google.protobuf.ByteString getLanguageCodeBytes()
       Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
       language tag of the language in this result. This language code was
       detected to have the most likelihood of being spoken in the audio.
       
      string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLanguageCodeBytes in interface StreamingRecognitionResultOrBuilder
      Returns:
      The bytes for languageCode.
    • setLanguageCode

      public StreamingRecognitionResult.Builder setLanguageCode(String value)
       Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
       language tag of the language in this result. This language code was
       detected to have the most likelihood of being spoken in the audio.
       
      string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The languageCode to set.
      Returns:
      This builder for chaining.
    • clearLanguageCode

      public StreamingRecognitionResult.Builder clearLanguageCode()
       Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
       language tag of the language in this result. This language code was
       detected to have the most likelihood of being spoken in the audio.
       
      string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • setLanguageCodeBytes

      public StreamingRecognitionResult.Builder setLanguageCodeBytes(com.google.protobuf.ByteString value)
       Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
       language tag of the language in this result. This language code was
       detected to have the most likelihood of being spoken in the audio.
       
      string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for languageCode to set.
      Returns:
      This builder for chaining.