Package com.google.cloud.speech.v2

Class StreamingRecognizeResponse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StreamingRecognizeResponse.Builder>
com.google.cloud.speech.v2.StreamingRecognizeResponse.Builder
All Implemented Interfaces:
StreamingRecognizeResponseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StreamingRecognizeResponse
public static final class StreamingRecognizeResponse.Builder extends com.google.protobuf.GeneratedMessage.Builder<StreamingRecognizeResponse.Builder> implements StreamingRecognizeResponseOrBuilder
 `StreamingRecognizeResponse` is the only message returned to the client by
 `StreamingRecognize`. A series of zero or more `StreamingRecognizeResponse`
 messages are streamed back to the client. If there is no recognizable
 audio then no messages are streamed back to the client.

 Here are some examples of `StreamingRecognizeResponse`s that might
 be returned while processing audio:

 1. results { alternatives { transcript: "tube" } stability: 0.01 }

 2. results { alternatives { transcript: "to be a" } stability: 0.01 }

 3. results { alternatives { transcript: "to be" } stability: 0.9 }
 results { alternatives { transcript: " or not to be" } stability: 0.01 }

 4. results { alternatives { transcript: "to be or not to be"
 confidence: 0.92 }
 alternatives { transcript: "to bee or not to bee" }
 is_final: true }

 5. results { alternatives { transcript: " that's" } stability: 0.01 }

 6. results { alternatives { transcript: " that is" } stability: 0.9 }
 results { alternatives { transcript: " the question" } stability: 0.01 }

 7. results { alternatives { transcript: " that is the question"
 confidence: 0.98 }
 alternatives { transcript: " that was the question" }
 is_final: true }

 Notes:

 - Only two of the above responses #4 and #7 contain final results; they are
 indicated by `is_final: true`. Concatenating these together generates the
 full transcript: "to be or not to be that is the question".

 - The others contain interim `results`. #3 and #6 contain two interim
 `results`: the first portion has a high stability and is less likely to
 change; the second portion has a low stability and is very likely to
 change. A UI designer might choose to show only high stability `results`.

 - The specific `stability` and `confidence` values shown above are only for
 illustrative purposes. Actual values may vary.

 - In each response, only one of these fields will be set:
 `error`,
 `speech_event_type`, or
 one or more (repeated) `results`.
Protobuf type google.cloud.speech.v2.StreamingRecognizeResponse

  • 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<StreamingRecognizeResponse.Builder>

    • clear

      public StreamingRecognizeResponse.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<StreamingRecognizeResponse.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<StreamingRecognizeResponse.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public StreamingRecognizeResponse.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<StreamingRecognizeResponse.Builder>

    • mergeFrom

      public StreamingRecognizeResponse.Builder mergeFrom(StreamingRecognizeResponse other)

    • isInitialized

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

    • mergeFrom

      public StreamingRecognizeResponse.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<StreamingRecognizeResponse.Builder>
      Throws:
      IOException

    • getResultsList

      public List<StreamingRecognitionResult> getResultsList()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
      Specified by:
      getResultsList in interface StreamingRecognizeResponseOrBuilder

    • getResultsCount

      public int getResultsCount()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
      Specified by:
      getResultsCount in interface StreamingRecognizeResponseOrBuilder

    • getResults

      public StreamingRecognitionResult getResults(int index)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
      Specified by:
      getResults in interface StreamingRecognizeResponseOrBuilder

    • setResults

      public StreamingRecognizeResponse.Builder setResults(int index, StreamingRecognitionResult value)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • setResults

      public StreamingRecognizeResponse.Builder setResults(int index, StreamingRecognitionResult.Builder builderForValue)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • addResults

      public StreamingRecognizeResponse.Builder addResults(StreamingRecognitionResult value)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • addResults

      public StreamingRecognizeResponse.Builder addResults(int index, StreamingRecognitionResult value)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • addResults

      public StreamingRecognizeResponse.Builder addResults(StreamingRecognitionResult.Builder builderForValue)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • addResults

      public StreamingRecognizeResponse.Builder addResults(int index, StreamingRecognitionResult.Builder builderForValue)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • addAllResults

      public StreamingRecognizeResponse.Builder addAllResults(Iterable<? extends StreamingRecognitionResult> values)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • clearResults

      public StreamingRecognizeResponse.Builder clearResults()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • removeResults

      public StreamingRecognizeResponse.Builder removeResults(int index)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • getResultsBuilder

      public StreamingRecognitionResult.Builder getResultsBuilder(int index)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • getResultsOrBuilder

      public StreamingRecognitionResultOrBuilder getResultsOrBuilder(int index)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
      Specified by:
      getResultsOrBuilder in interface StreamingRecognizeResponseOrBuilder

    • getResultsOrBuilderList

      public List<? extends StreamingRecognitionResultOrBuilder> getResultsOrBuilderList()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;
      Specified by:
      getResultsOrBuilderList in interface StreamingRecognizeResponseOrBuilder

    • addResultsBuilder

      public StreamingRecognitionResult.Builder addResultsBuilder()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • addResultsBuilder

      public StreamingRecognitionResult.Builder addResultsBuilder(int index)
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • getResultsBuilderList

      public List<StreamingRecognitionResult.Builder> getResultsBuilderList()
       This repeated list contains zero or more results that
 correspond to consecutive portions of the audio currently being processed.
 It contains zero or one
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`true`
 result (the newly settled portion), followed by zero or more
 [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=`false`
 results (the interim results).
      repeated .google.cloud.speech.v2.StreamingRecognitionResult results = 6;

    • getSpeechEventTypeValue

      public int getSpeechEventTypeValue()
       Indicates the type of speech event.
      .google.cloud.speech.v2.StreamingRecognizeResponse.SpeechEventType speech_event_type = 3;
      Specified by:
      getSpeechEventTypeValue in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The enum numeric value on the wire for speechEventType.

    • setSpeechEventTypeValue

      public StreamingRecognizeResponse.Builder setSpeechEventTypeValue(int value)
       Indicates the type of speech event.
      .google.cloud.speech.v2.StreamingRecognizeResponse.SpeechEventType speech_event_type = 3;
      Parameters:
      value - The enum numeric value on the wire for speechEventType to set.
      Returns:
      This builder for chaining.

    • getSpeechEventType

      public StreamingRecognizeResponse.SpeechEventType getSpeechEventType()
       Indicates the type of speech event.
      .google.cloud.speech.v2.StreamingRecognizeResponse.SpeechEventType speech_event_type = 3;
      Specified by:
      getSpeechEventType in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The speechEventType.

    • setSpeechEventType

      public StreamingRecognizeResponse.Builder setSpeechEventType(StreamingRecognizeResponse.SpeechEventType value)
       Indicates the type of speech event.
      .google.cloud.speech.v2.StreamingRecognizeResponse.SpeechEventType speech_event_type = 3;
      Parameters:
      value - The speechEventType to set.
      Returns:
      This builder for chaining.

    • clearSpeechEventType

      public StreamingRecognizeResponse.Builder clearSpeechEventType()
       Indicates the type of speech event.
      .google.cloud.speech.v2.StreamingRecognizeResponse.SpeechEventType speech_event_type = 3;
      Returns:
      This builder for chaining.

    • hasSpeechEventOffset

      public boolean hasSpeechEventOffset()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;
      Specified by:
      hasSpeechEventOffset in interface StreamingRecognizeResponseOrBuilder
      Returns:
      Whether the speechEventOffset field is set.

    • getSpeechEventOffset

      public com.google.protobuf.Duration getSpeechEventOffset()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;
      Specified by:
      getSpeechEventOffset in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The speechEventOffset.

    • setSpeechEventOffset

      public StreamingRecognizeResponse.Builder setSpeechEventOffset(com.google.protobuf.Duration value)
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;

    • setSpeechEventOffset

      public StreamingRecognizeResponse.Builder setSpeechEventOffset(com.google.protobuf.Duration.Builder builderForValue)
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;

    • mergeSpeechEventOffset

      public StreamingRecognizeResponse.Builder mergeSpeechEventOffset(com.google.protobuf.Duration value)
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;

    • clearSpeechEventOffset

      public StreamingRecognizeResponse.Builder clearSpeechEventOffset()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;

    • getSpeechEventOffsetBuilder

      public com.google.protobuf.Duration.Builder getSpeechEventOffsetBuilder()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;

    • getSpeechEventOffsetOrBuilder

      public com.google.protobuf.DurationOrBuilder getSpeechEventOffsetOrBuilder()
       Time offset between the beginning of the audio and event emission.
      .google.protobuf.Duration speech_event_offset = 7;
      Specified by:
      getSpeechEventOffsetOrBuilder in interface StreamingRecognizeResponseOrBuilder

    • hasMetadata

      public boolean hasMetadata()
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;
      Specified by:
      hasMetadata in interface StreamingRecognizeResponseOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public RecognitionResponseMetadata getMetadata()
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;
      Specified by:
      getMetadata in interface StreamingRecognizeResponseOrBuilder
      Returns:
      The metadata.

    • setMetadata

      public StreamingRecognizeResponse.Builder setMetadata(RecognitionResponseMetadata value)
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;

    • setMetadata

      public StreamingRecognizeResponse.Builder setMetadata(RecognitionResponseMetadata.Builder builderForValue)
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;

    • mergeMetadata

      public StreamingRecognizeResponse.Builder mergeMetadata(RecognitionResponseMetadata value)
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;

    • clearMetadata

      public StreamingRecognizeResponse.Builder clearMetadata()
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;

    • getMetadataBuilder

      public RecognitionResponseMetadata.Builder getMetadataBuilder()
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;

    • getMetadataOrBuilder

      public RecognitionResponseMetadataOrBuilder getMetadataOrBuilder()
       Metadata about the recognition.
      .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 5;
      Specified by:
      getMetadataOrBuilder in interface StreamingRecognizeResponseOrBuilder