Class StreamingRecognitionConfig.Builder (4.25.0)

Version 4.25.0

• 4.49.0 (latest)
• 4.48.0
• 4.47.0
• 4.46.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.0.0
• 2.6.1
• 2.5.9
• 2.4.0
• 2.3.0
• 2.2.15

public static final class StreamingRecognitionConfig.Builder extends GeneratedMessageV3.Builder<StreamingRecognitionConfig.Builder> implements StreamingRecognitionConfigOrBuilder

Provides information to the recognizer that specifies how to process the request.

Protobuf type google.cloud.speech.v1.StreamingRecognitionConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StreamingRecognitionConfig.Builder

Implements

StreamingRecognitionConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StreamingRecognitionConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public StreamingRecognitionConfig build()

Returns
Type	Description
StreamingRecognitionConfig

buildPartial()

public StreamingRecognitionConfig buildPartial()

Returns
Type	Description
StreamingRecognitionConfig

clear()

public StreamingRecognitionConfig.Builder clear()

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConfig()

public StreamingRecognitionConfig.Builder clearConfig()

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
StreamingRecognitionConfig.Builder

clearEnableVoiceActivityEvents()

public StreamingRecognitionConfig.Builder clearEnableVoiceActivityEvents()

If true, responses with voice activity speech events will be returned as they are detected.

bool enable_voice_activity_events = 5;

Returns
Type	Description
StreamingRecognitionConfig.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StreamingRecognitionConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInterimResults()

public StreamingRecognitionConfig.Builder clearInterimResults()

If true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with the is_final=false flag). If false or omitted, only is_final=true result(s) are returned.

bool interim_results = 3;

Returns
Type	Description
StreamingRecognitionConfig.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StreamingRecognitionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSingleUtterance()

public StreamingRecognitionConfig.Builder clearSingleUtterance()

If false or omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multiple StreamingRecognitionResults with the is_final flag set to true.

If true, the recognizer will detect a single spoken utterance. When it detects that the user has paused or stopped speaking, it will return an END_OF_SINGLE_UTTERANCE event and cease recognition. It will return no more than one StreamingRecognitionResult with the is_final flag set to true.

The single_utterance field can only be used with specified models, otherwise an error is thrown. The model field in [RecognitionConfig][] must be set to:

• command_and_search
• phone_call AND additional field useEnhanced=true
• The model field is left undefined. In this case the API auto-selects a model based on any other parameters that you set in RecognitionConfig.

bool single_utterance = 2;

Returns
Type	Description
StreamingRecognitionConfig.Builder	This builder for chaining.

clearVoiceActivityTimeout()

public StreamingRecognitionConfig.Builder clearVoiceActivityTimeout()

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Returns
Type	Description
StreamingRecognitionConfig.Builder

clone()

public StreamingRecognitionConfig.Builder clone()

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getConfig()

public RecognitionConfig getConfig()

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
RecognitionConfig	The config.

getConfigBuilder()

public RecognitionConfig.Builder getConfigBuilder()

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
RecognitionConfig.Builder

getConfigOrBuilder()

public RecognitionConfigOrBuilder getConfigOrBuilder()

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
RecognitionConfigOrBuilder

getDefaultInstanceForType()

public StreamingRecognitionConfig getDefaultInstanceForType()

Returns
Type	Description
StreamingRecognitionConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEnableVoiceActivityEvents()

public boolean getEnableVoiceActivityEvents()

If true, responses with voice activity speech events will be returned as they are detected.

bool enable_voice_activity_events = 5;

Returns
Type	Description
boolean	The enableVoiceActivityEvents.

getInterimResults()

public boolean getInterimResults()

If true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with the is_final=false flag). If false or omitted, only is_final=true result(s) are returned.

bool interim_results = 3;

Returns
Type	Description
boolean	The interimResults.

getSingleUtterance()

public boolean getSingleUtterance()

If false or omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multiple StreamingRecognitionResults with the is_final flag set to true.

If true, the recognizer will detect a single spoken utterance. When it detects that the user has paused or stopped speaking, it will return an END_OF_SINGLE_UTTERANCE event and cease recognition. It will return no more than one StreamingRecognitionResult with the is_final flag set to true.

The single_utterance field can only be used with specified models, otherwise an error is thrown. The model field in [RecognitionConfig][] must be set to:

• command_and_search
• phone_call AND additional field useEnhanced=true
• The model field is left undefined. In this case the API auto-selects a model based on any other parameters that you set in RecognitionConfig.

bool single_utterance = 2;

Returns
Type	Description
boolean	The singleUtterance.

getVoiceActivityTimeout()

public StreamingRecognitionConfig.VoiceActivityTimeout getVoiceActivityTimeout()

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Returns
Type	Description
StreamingRecognitionConfig.VoiceActivityTimeout	The voiceActivityTimeout.

getVoiceActivityTimeoutBuilder()

public StreamingRecognitionConfig.VoiceActivityTimeout.Builder getVoiceActivityTimeoutBuilder()

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Returns
Type	Description
StreamingRecognitionConfig.VoiceActivityTimeout.Builder

getVoiceActivityTimeoutOrBuilder()

public StreamingRecognitionConfig.VoiceActivityTimeoutOrBuilder getVoiceActivityTimeoutOrBuilder()

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Returns
Type	Description
StreamingRecognitionConfig.VoiceActivityTimeoutOrBuilder

hasConfig()

public boolean hasConfig()

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the config field is set.

hasVoiceActivityTimeout()

public boolean hasVoiceActivityTimeout()

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Returns
Type	Description
boolean	Whether the voiceActivityTimeout field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeConfig(RecognitionConfig value)

public StreamingRecognitionConfig.Builder mergeConfig(RecognitionConfig value)

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	RecognitionConfig

Returns
Type	Description
StreamingRecognitionConfig.Builder

mergeFrom(StreamingRecognitionConfig other)

public StreamingRecognitionConfig.Builder mergeFrom(StreamingRecognitionConfig other)

Parameter
Name	Description
other	StreamingRecognitionConfig

Returns
Type	Description
StreamingRecognitionConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StreamingRecognitionConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public StreamingRecognitionConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StreamingRecognitionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeVoiceActivityTimeout(StreamingRecognitionConfig.VoiceActivityTimeout value)

public StreamingRecognitionConfig.Builder mergeVoiceActivityTimeout(StreamingRecognitionConfig.VoiceActivityTimeout value)

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Parameter
Name	Description
value	StreamingRecognitionConfig.VoiceActivityTimeout

Returns
Type	Description
StreamingRecognitionConfig.Builder

setConfig(RecognitionConfig value)

public StreamingRecognitionConfig.Builder setConfig(RecognitionConfig value)

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	RecognitionConfig

Returns
Type	Description
StreamingRecognitionConfig.Builder

setConfig(RecognitionConfig.Builder builderForValue)

public StreamingRecognitionConfig.Builder setConfig(RecognitionConfig.Builder builderForValue)

Required. Provides information to the recognizer that specifies how to process the request.

.google.cloud.speech.v1.RecognitionConfig config = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	RecognitionConfig.Builder

Returns
Type	Description
StreamingRecognitionConfig.Builder

setEnableVoiceActivityEvents(boolean value)

public StreamingRecognitionConfig.Builder setEnableVoiceActivityEvents(boolean value)

If true, responses with voice activity speech events will be returned as they are detected.

bool enable_voice_activity_events = 5;

Parameter
Name	Description
value	boolean The enableVoiceActivityEvents to set.

Returns
Type	Description
StreamingRecognitionConfig.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StreamingRecognitionConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInterimResults(boolean value)

public StreamingRecognitionConfig.Builder setInterimResults(boolean value)

If true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with the is_final=false flag). If false or omitted, only is_final=true result(s) are returned.

bool interim_results = 3;

Parameter
Name	Description
value	boolean The interimResults to set.

Returns
Type	Description
StreamingRecognitionConfig.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StreamingRecognitionConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSingleUtterance(boolean value)

public StreamingRecognitionConfig.Builder setSingleUtterance(boolean value)

If false or omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multiple StreamingRecognitionResults with the is_final flag set to true.

If true, the recognizer will detect a single spoken utterance. When it detects that the user has paused or stopped speaking, it will return an END_OF_SINGLE_UTTERANCE event and cease recognition. It will return no more than one StreamingRecognitionResult with the is_final flag set to true.

The single_utterance field can only be used with specified models, otherwise an error is thrown. The model field in [RecognitionConfig][] must be set to:

• command_and_search
• phone_call AND additional field useEnhanced=true
• The model field is left undefined. In this case the API auto-selects a model based on any other parameters that you set in RecognitionConfig.

bool single_utterance = 2;

Parameter
Name	Description
value	boolean The singleUtterance to set.

Returns
Type	Description
StreamingRecognitionConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final StreamingRecognitionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StreamingRecognitionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVoiceActivityTimeout(StreamingRecognitionConfig.VoiceActivityTimeout value)

public StreamingRecognitionConfig.Builder setVoiceActivityTimeout(StreamingRecognitionConfig.VoiceActivityTimeout value)

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Parameter
Name	Description
value	StreamingRecognitionConfig.VoiceActivityTimeout

Returns
Type	Description
StreamingRecognitionConfig.Builder

setVoiceActivityTimeout(StreamingRecognitionConfig.VoiceActivityTimeout.Builder builderForValue)

public StreamingRecognitionConfig.Builder setVoiceActivityTimeout(StreamingRecognitionConfig.VoiceActivityTimeout.Builder builderForValue)

If set, the server will automatically close the stream after the specified duration has elapsed after the last VOICE_ACTIVITY speech event has been sent. The field voice_activity_events must also be set to true.

.google.cloud.speech.v1.StreamingRecognitionConfig.VoiceActivityTimeout voice_activity_timeout = 6;

Parameter
Name	Description
builderForValue	StreamingRecognitionConfig.VoiceActivityTimeout.Builder

Returns
Type	Description
StreamingRecognitionConfig.Builder