Package com.google.cloud.speech.v1beta1

Class 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.GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>
implements StreamingRecognizeResponseOrBuilder
     `StreamingRecognizeResponse` is the only message returned to the client by
 `StreamingRecognize`. A series of one or more `StreamingRecognizeResponse`
 messages are streamed back to the client.
 Here's an example of a series of ten `StreamingRecognizeResponse`s that might
 be returned while processing audio:
 1. endpointer_type: START_OF_SPEECH
 2. results { alternatives { transcript: "tube" } stability: 0.01 }
    result_index: 0
 3. results { alternatives { transcript: "to be a" } stability: 0.01 }
    result_index: 0
 4. results { alternatives { transcript: "to be" } stability: 0.9 }
    results { alternatives { transcript: " or not to be" } stability: 0.01 }
    result_index: 0
 5. results { alternatives { transcript: "to be or not to be"
                             confidence: 0.92 }
              alternatives { transcript: "to bee or not to bee" }
              is_final: true }
    result_index: 0
 6. results { alternatives { transcript: " that's" } stability: 0.01 }
    result_index: 1
 7. results { alternatives { transcript: " that is" } stability: 0.9 }
    results { alternatives { transcript: " the question" } stability: 0.01 }
    result_index: 1
 8. endpointer_type: END_OF_SPEECH
 9. results { alternatives { transcript: " that is the question"
                             confidence: 0.98 }
              alternatives { transcript: " that was the question" }
              is_final: true }
    result_index: 1
 10. endpointer_type: END_OF_AUDIO
 Notes:
 - Only two of the above responses #5 and #9 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`. #4 and #7 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.
 - The `result_index` indicates the portion of audio that has had final
   results returned, and is no longer being processed. For example, the
   `results` in #6 and later correspond to the portion of audio after
   "to be or not to be".
    Protobuf type google.cloud.speech.v1beta1.StreamingRecognizeResponse

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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

      • hasError

        public boolean hasError()
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;
        Specified by:
        hasError in interface StreamingRecognizeResponseOrBuilder

      • getError

        public com.google.rpc.Status getError()
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;
        Specified by:
        getError in interface StreamingRecognizeResponseOrBuilder

      • setError

        public StreamingRecognizeResponse.Builder setError​(com.google.rpc.Status value)
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;

      • setError

        public StreamingRecognizeResponse.Builder setError​(com.google.rpc.Status.Builder builderForValue)
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;

      • mergeError

        public StreamingRecognizeResponse.Builder mergeError​(com.google.rpc.Status value)
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;

      • clearError

        public StreamingRecognizeResponse.Builder clearError()
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;

      • getErrorBuilder

        public com.google.rpc.Status.Builder getErrorBuilder()
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;

      • getErrorOrBuilder

        public com.google.rpc.StatusOrBuilder getErrorOrBuilder()
         *Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that
 specifies the error for the operation.
        .google.rpc.Status error = 1;
        Specified by:
        getErrorOrBuilder in interface StreamingRecognizeResponseOrBuilder

      • getResultsList

        public List<StreamingRecognitionResult> getResultsList()
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsList in interface StreamingRecognizeResponseOrBuilder

      • getResultsCount

        public int getResultsCount()
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsCount in interface StreamingRecognizeResponseOrBuilder

      • getResults

        public StreamingRecognitionResult getResults​(int index)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResults in interface StreamingRecognizeResponseOrBuilder

      • setResults

        public StreamingRecognizeResponse.Builder setResults​(int index,
                                                     StreamingRecognitionResult value)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • setResults

        public StreamingRecognizeResponse.Builder setResults​(int index,
                                                     StreamingRecognitionResult.Builder builderForValue)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • addResults

        public StreamingRecognizeResponse.Builder addResults​(StreamingRecognitionResult value)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • addResults

        public StreamingRecognizeResponse.Builder addResults​(int index,
                                                     StreamingRecognitionResult value)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • addResults

        public StreamingRecognizeResponse.Builder addResults​(StreamingRecognitionResult.Builder builderForValue)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • addResults

        public StreamingRecognizeResponse.Builder addResults​(int index,
                                                     StreamingRecognitionResult.Builder builderForValue)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • addAllResults

        public StreamingRecognizeResponse.Builder addAllResults​(Iterable<? extends StreamingRecognitionResult> values)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • clearResults

        public StreamingRecognizeResponse.Builder clearResults()
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • removeResults

        public StreamingRecognizeResponse.Builder removeResults​(int index)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • getResultsBuilder

        public StreamingRecognitionResult.Builder getResultsBuilder​(int index)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • getResultsOrBuilder

        public StreamingRecognitionResultOrBuilder getResultsOrBuilder​(int index)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsOrBuilder in interface StreamingRecognizeResponseOrBuilder

      • getResultsOrBuilderList

        public List<? extends StreamingRecognitionResultOrBuilder> getResultsOrBuilderList()
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;
        Specified by:
        getResultsOrBuilderList in interface StreamingRecognizeResponseOrBuilder

      • addResultsBuilder

        public StreamingRecognitionResult.Builder addResultsBuilder()
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • addResultsBuilder

        public StreamingRecognitionResult.Builder addResultsBuilder​(int index)
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • getResultsBuilderList

        public List<StreamingRecognitionResult.Builder> getResultsBuilderList()
         *Output-only* 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results.
        repeated .google.cloud.speech.v1beta1.StreamingRecognitionResult results = 2;

      • getResultIndex

        public int getResultIndex()
         *Output-only* Indicates the lowest index in the `results` array that has
 changed. The repeated `StreamingRecognitionResult` results overwrite past
 results at this index and higher.
        int32 result_index = 3;
        Specified by:
        getResultIndex in interface StreamingRecognizeResponseOrBuilder

      • setResultIndex

        public StreamingRecognizeResponse.Builder setResultIndex​(int value)
         *Output-only* Indicates the lowest index in the `results` array that has
 changed. The repeated `StreamingRecognitionResult` results overwrite past
 results at this index and higher.
        int32 result_index = 3;

      • clearResultIndex

        public StreamingRecognizeResponse.Builder clearResultIndex()
         *Output-only* Indicates the lowest index in the `results` array that has
 changed. The repeated `StreamingRecognitionResult` results overwrite past
 results at this index and higher.
        int32 result_index = 3;

      • getEndpointerTypeValue

        public int getEndpointerTypeValue()
         *Output-only* Indicates the type of endpointer event.
        .google.cloud.speech.v1beta1.StreamingRecognizeResponse.EndpointerType endpointer_type = 4;
        Specified by:
        getEndpointerTypeValue in interface StreamingRecognizeResponseOrBuilder

      • setEndpointerTypeValue

        public StreamingRecognizeResponse.Builder setEndpointerTypeValue​(int value)
         *Output-only* Indicates the type of endpointer event.
        .google.cloud.speech.v1beta1.StreamingRecognizeResponse.EndpointerType endpointer_type = 4;

      • clearEndpointerType

        public StreamingRecognizeResponse.Builder clearEndpointerType()
         *Output-only* Indicates the type of endpointer event.
        .google.cloud.speech.v1beta1.StreamingRecognizeResponse.EndpointerType endpointer_type = 4;

      • setUnknownFields

        public final StreamingRecognizeResponse.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

      • mergeUnknownFields

        public final StreamingRecognizeResponse.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>