StreamingRecognizeResponse.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>
    - - com.google.cloud.speech.v1beta1.StreamingRecognizeResponse.Builder

All Implemented Interfaces:: StreamingRecognizeResponseOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: StreamingRecognizeResponse

public static final class StreamingRecognizeResponse.Builder
extends 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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamingRecognizeResponse.Builder`	`addAllResults(java.lang.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.
`StreamingRecognizeResponse.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`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.
`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.
`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.
`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.
`StreamingRecognitionResult.Builder`	`addResultsBuilder()` Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
`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.
`StreamingRecognizeResponse`	`build()`
`StreamingRecognizeResponse`	`buildPartial()`
`StreamingRecognizeResponse.Builder`	`clear()`
`StreamingRecognizeResponse.Builder`	`clearEndpointerType()` Output-only Indicates the type of endpointer event.
`StreamingRecognizeResponse.Builder`	`clearError()` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`StreamingRecognizeResponse.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`StreamingRecognizeResponse.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`StreamingRecognizeResponse.Builder`	`clearResultIndex()` Output-only Indicates the lowest index in the `results` array that has changed.
`StreamingRecognizeResponse.Builder`	`clearResults()` Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
`StreamingRecognizeResponse.Builder`	`clone()`
`StreamingRecognizeResponse`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`StreamingRecognizeResponse.EndpointerType`	`getEndpointerType()` Output-only Indicates the type of endpointer event.
`int`	`getEndpointerTypeValue()` Output-only Indicates the type of endpointer event.
`Status`	`getError()` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`Status.Builder`	`getErrorBuilder()` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`StatusOrBuilder`	`getErrorOrBuilder()` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`int`	`getResultIndex()` Output-only Indicates the lowest index in the `results` array that has changed.
`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.
`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.
`java.util.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.
`int`	`getResultsCount()` Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
`java.util.List<StreamingRecognitionResult>`	`getResultsList()` Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
`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.
`java.util.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.
`boolean`	`hasError()` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`StreamingRecognizeResponse.Builder`	`mergeError(Status value)` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`StreamingRecognizeResponse.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`StreamingRecognizeResponse.Builder`	`mergeFrom(Message other)`
`StreamingRecognizeResponse.Builder`	`mergeFrom(StreamingRecognizeResponse other)`
`StreamingRecognizeResponse.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`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.
`StreamingRecognizeResponse.Builder`	`setEndpointerType(StreamingRecognizeResponse.EndpointerType value)` Output-only Indicates the type of endpointer event.
`StreamingRecognizeResponse.Builder`	`setEndpointerTypeValue(int value)` Output-only Indicates the type of endpointer event.
`StreamingRecognizeResponse.Builder`	`setError(Status.Builder builderForValue)` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`StreamingRecognizeResponse.Builder`	`setError(Status value)` Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
`StreamingRecognizeResponse.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`StreamingRecognizeResponse.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`StreamingRecognizeResponse.Builder`	`setResultIndex(int value)` Output-only Indicates the lowest index in the `results` array that has changed.
`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.
`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.
`StreamingRecognizeResponse.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

clear
```
public StreamingRecognizeResponse.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

getDefaultInstanceForType
```
public StreamingRecognizeResponse getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public StreamingRecognizeResponse build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public StreamingRecognizeResponse buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public StreamingRecognizeResponse.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

setField

public StreamingRecognizeResponse.Builder setField(Descriptors.FieldDescriptor field,
                                                   java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

clearField
```
public StreamingRecognizeResponse.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

clearOneof
```
public StreamingRecognizeResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

setRepeatedField

public StreamingRecognizeResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                           int index,
                                                           java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

addRepeatedField

public StreamingRecognizeResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                           java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

mergeFrom
```
public StreamingRecognizeResponse.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<StreamingRecognizeResponse.Builder>

mergeFrom

public StreamingRecognizeResponse.Builder mergeFrom(StreamingRecognizeResponse other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<StreamingRecognizeResponse.Builder>

mergeFrom

public StreamingRecognizeResponse.Builder mergeFrom(CodedInputStream input,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<StreamingRecognizeResponse.Builder>
Throws:: java.io.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 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(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(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(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 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 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