Package com.google.cloud.speech.v1

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 zero or more `StreamingRecognizeResponse`
 messages are streamed back to the client. If there is no recognizable
 audio, and `single_utterance` is set to false, then no messages are streamed
 back to the client.

 Here's an example of a series 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.v1.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()
         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
        Returns:
        Whether the error field is set.

      • getError

        public com.google.rpc.Status getError()
         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
        Returns:
        The error.

      • setError

        public StreamingRecognizeResponse.Builder setError​(com.google.rpc.Status value)
         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)
         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)
         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()
         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()
         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()
         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()
         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 (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
        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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
        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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
        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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
        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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;
        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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • 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=true` result (the newly settled portion),
 followed by zero or more `is_final=false` results (the interim results).
        repeated .google.cloud.speech.v1.StreamingRecognitionResult results = 2;

      • getSpeechEventTypeValue

        public int getSpeechEventTypeValue()
         Indicates the type of speech event.
        .google.cloud.speech.v1.StreamingRecognizeResponse.SpeechEventType speech_event_type = 4;
        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.v1.StreamingRecognizeResponse.SpeechEventType speech_event_type = 4;
        Parameters:
        value - The enum numeric value on the wire for speechEventType to set.
        Returns:
        This builder for chaining.

      • clearSpeechEventType

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

      • hasSpeechEventTime

        public boolean hasSpeechEventTime()
         Time offset between the beginning of the audio and event emission.
        .google.protobuf.Duration speech_event_time = 8;
        Specified by:
        hasSpeechEventTime in interface StreamingRecognizeResponseOrBuilder
        Returns:
        Whether the speechEventTime field is set.

      • getSpeechEventTime

        public com.google.protobuf.Duration getSpeechEventTime()
         Time offset between the beginning of the audio and event emission.
        .google.protobuf.Duration speech_event_time = 8;
        Specified by:
        getSpeechEventTime in interface StreamingRecognizeResponseOrBuilder
        Returns:
        The speechEventTime.

      • setSpeechEventTime

        public StreamingRecognizeResponse.Builder setSpeechEventTime​(com.google.protobuf.Duration value)
         Time offset between the beginning of the audio and event emission.
        .google.protobuf.Duration speech_event_time = 8;

      • setSpeechEventTime

        public StreamingRecognizeResponse.Builder setSpeechEventTime​(com.google.protobuf.Duration.Builder builderForValue)
         Time offset between the beginning of the audio and event emission.
        .google.protobuf.Duration speech_event_time = 8;

      • mergeSpeechEventTime

        public StreamingRecognizeResponse.Builder mergeSpeechEventTime​(com.google.protobuf.Duration value)
         Time offset between the beginning of the audio and event emission.
        .google.protobuf.Duration speech_event_time = 8;

      • clearSpeechEventTime

        public StreamingRecognizeResponse.Builder clearSpeechEventTime()
         Time offset between the beginning of the audio and event emission.
        .google.protobuf.Duration speech_event_time = 8;

      • getSpeechEventTimeBuilder

        public com.google.protobuf.Duration.Builder getSpeechEventTimeBuilder()
         Time offset between the beginning of the audio and event emission.
        .google.protobuf.Duration speech_event_time = 8;

      • getSpeechEventTimeOrBuilder

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

      • hasTotalBilledTime

        public boolean hasTotalBilledTime()
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;
        Specified by:
        hasTotalBilledTime in interface StreamingRecognizeResponseOrBuilder
        Returns:
        Whether the totalBilledTime field is set.

      • getTotalBilledTime

        public com.google.protobuf.Duration getTotalBilledTime()
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;
        Specified by:
        getTotalBilledTime in interface StreamingRecognizeResponseOrBuilder
        Returns:
        The totalBilledTime.

      • setTotalBilledTime

        public StreamingRecognizeResponse.Builder setTotalBilledTime​(com.google.protobuf.Duration value)
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;

      • setTotalBilledTime

        public StreamingRecognizeResponse.Builder setTotalBilledTime​(com.google.protobuf.Duration.Builder builderForValue)
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;

      • mergeTotalBilledTime

        public StreamingRecognizeResponse.Builder mergeTotalBilledTime​(com.google.protobuf.Duration value)
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;

      • clearTotalBilledTime

        public StreamingRecognizeResponse.Builder clearTotalBilledTime()
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;

      • getTotalBilledTimeBuilder

        public com.google.protobuf.Duration.Builder getTotalBilledTimeBuilder()
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;

      • getTotalBilledTimeOrBuilder

        public com.google.protobuf.DurationOrBuilder getTotalBilledTimeOrBuilder()
         When available, billed audio seconds for the stream.
 Set only if this is the last response in the stream.
        .google.protobuf.Duration total_billed_time = 5;
        Specified by:
        getTotalBilledTimeOrBuilder in interface StreamingRecognizeResponseOrBuilder

      • hasSpeechAdaptationInfo

        public boolean hasSpeechAdaptationInfo()
         Provides information on adaptation behavior in response
        .google.cloud.speech.v1.SpeechAdaptationInfo speech_adaptation_info = 9;
        Specified by:
        hasSpeechAdaptationInfo in interface StreamingRecognizeResponseOrBuilder
        Returns:
        Whether the speechAdaptationInfo field is set.

      • clearSpeechAdaptationInfo

        public StreamingRecognizeResponse.Builder clearSpeechAdaptationInfo()
         Provides information on adaptation behavior in response
        .google.cloud.speech.v1.SpeechAdaptationInfo speech_adaptation_info = 9;

      • getSpeechAdaptationInfoBuilder

        public SpeechAdaptationInfo.Builder getSpeechAdaptationInfoBuilder()
         Provides information on adaptation behavior in response
        .google.cloud.speech.v1.SpeechAdaptationInfo speech_adaptation_info = 9;

      • getRequestId

        public long getRequestId()
         The ID associated with the request. This is a unique ID specific only to
 the given request.
        int64 request_id = 10;
        Specified by:
        getRequestId in interface StreamingRecognizeResponseOrBuilder
        Returns:
        The requestId.

      • setRequestId

        public StreamingRecognizeResponse.Builder setRequestId​(long value)
         The ID associated with the request. This is a unique ID specific only to
 the given request.
        int64 request_id = 10;
        Parameters:
        value - The requestId to set.
        Returns:
        This builder for chaining.

      • clearRequestId

        public StreamingRecognizeResponse.Builder clearRequestId()
         The ID associated with the request. This is a unique ID specific only to
 the given request.
        int64 request_id = 10;
        Returns:
        This builder for chaining.

      • 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>