Class RecognizeRequest.Builder (4.38.0) 

public static final class RecognizeRequest.Builder extends GeneratedMessageV3.Builder<RecognizeRequest.Builder> implements RecognizeRequestOrBuilder

Request message for the Recognize method. Either content or uri must be supplied. Supplying both or neither returns INVALID_ARGUMENT. See content limits.

Protobuf type google.cloud.speech.v2.RecognizeRequest

Inheritance

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RecognizeRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecognizeRequest.Builder
Overrides

build()

public RecognizeRequest build()
Returns
Type Description
RecognizeRequest

buildPartial()

public RecognizeRequest buildPartial()
Returns
Type Description
RecognizeRequest

clear()

public RecognizeRequest.Builder clear()
Returns
Type Description
RecognizeRequest.Builder
Overrides

clearAudioSource()

public RecognizeRequest.Builder clearAudioSource()
Returns
Type Description
RecognizeRequest.Builder

clearConfig()

public RecognizeRequest.Builder clearConfig()

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Returns
Type Description
RecognizeRequest.Builder

clearConfigMask()

public RecognizeRequest.Builder clearConfigMask()

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Returns
Type Description
RecognizeRequest.Builder

clearContent()

public RecognizeRequest.Builder clearContent()

The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

bytes content = 5;

Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RecognizeRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RecognizeRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RecognizeRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RecognizeRequest.Builder
Overrides

clearRecognizer()

public RecognizeRequest.Builder clearRecognizer()

Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

string recognizer = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.

clearUri()

public RecognizeRequest.Builder clearUri()

URI that points to a file that contains audio data bytes as specified in RecognitionConfig. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return INVALID_ARGUMENT). For more information, see Request URIs.

string uri = 6;

Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.

clone()

public RecognizeRequest.Builder clone()
Returns
Type Description
RecognizeRequest.Builder
Overrides

getAudioSourceCase()

public RecognizeRequest.AudioSourceCase getAudioSourceCase()
Returns
Type Description
RecognizeRequest.AudioSourceCase

getConfig()

public RecognitionConfig getConfig()

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Returns
Type Description
RecognitionConfig

The config.

getConfigBuilder()

public RecognitionConfig.Builder getConfigBuilder()

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Returns
Type Description
RecognitionConfig.Builder

getConfigMask()

public FieldMask getConfigMask()

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Returns
Type Description
FieldMask

The configMask.

getConfigMaskBuilder()

public FieldMask.Builder getConfigMaskBuilder()

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Returns
Type Description
Builder

getConfigMaskOrBuilder()

public FieldMaskOrBuilder getConfigMaskOrBuilder()

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Returns
Type Description
FieldMaskOrBuilder

getConfigOrBuilder()

public RecognitionConfigOrBuilder getConfigOrBuilder()

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Returns
Type Description
RecognitionConfigOrBuilder

getContent()

public ByteString getContent()

The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

bytes content = 5;

Returns
Type Description
ByteString

The content.

getDefaultInstanceForType()

public RecognizeRequest getDefaultInstanceForType()
Returns
Type Description
RecognizeRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getRecognizer()

public String getRecognizer()

Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

string recognizer = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The recognizer.

getRecognizerBytes()

public ByteString getRecognizerBytes()

Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

string recognizer = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for recognizer.

getUri()

public String getUri()

URI that points to a file that contains audio data bytes as specified in RecognitionConfig. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return INVALID_ARGUMENT). For more information, see Request URIs.

string uri = 6;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

URI that points to a file that contains audio data bytes as specified in RecognitionConfig. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return INVALID_ARGUMENT). For more information, see Request URIs.

string uri = 6;

Returns
Type Description
ByteString

The bytes for uri.

hasConfig()

public boolean hasConfig()

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Returns
Type Description
boolean

Whether the config field is set.

hasConfigMask()

public boolean hasConfigMask()

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Returns
Type Description
boolean

Whether the configMask field is set.

hasContent()

public boolean hasContent()

The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

bytes content = 5;

Returns
Type Description
boolean

Whether the content field is set.

hasUri()

public boolean hasUri()

URI that points to a file that contains audio data bytes as specified in RecognitionConfig. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return INVALID_ARGUMENT). For more information, see Request URIs.

string uri = 6;

Returns
Type Description
boolean

Whether the uri field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConfig(RecognitionConfig value)

public RecognizeRequest.Builder mergeConfig(RecognitionConfig value)

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Parameter
Name Description
value RecognitionConfig
Returns
Type Description
RecognizeRequest.Builder

mergeConfigMask(FieldMask value)

public RecognizeRequest.Builder mergeConfigMask(FieldMask value)

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Parameter
Name Description
value FieldMask
Returns
Type Description
RecognizeRequest.Builder

mergeFrom(RecognizeRequest other)

public RecognizeRequest.Builder mergeFrom(RecognizeRequest other)
Parameter
Name Description
other RecognizeRequest
Returns
Type Description
RecognizeRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RecognizeRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognizeRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RecognizeRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RecognizeRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RecognizeRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecognizeRequest.Builder
Overrides

setConfig(RecognitionConfig value)

public RecognizeRequest.Builder setConfig(RecognitionConfig value)

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Parameter
Name Description
value RecognitionConfig
Returns
Type Description
RecognizeRequest.Builder

setConfig(RecognitionConfig.Builder builderForValue)

public RecognizeRequest.Builder setConfig(RecognitionConfig.Builder builderForValue)

Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource.

.google.cloud.speech.v2.RecognitionConfig config = 1;

Parameter
Name Description
builderForValue RecognitionConfig.Builder
Returns
Type Description
RecognizeRequest.Builder

setConfigMask(FieldMask value)

public RecognizeRequest.Builder setConfigMask(FieldMask value)

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Parameter
Name Description
value FieldMask
Returns
Type Description
RecognizeRequest.Builder

setConfigMask(FieldMask.Builder builderForValue)

public RecognizeRequest.Builder setConfigMask(FieldMask.Builder builderForValue)

The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

.google.protobuf.FieldMask config_mask = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RecognizeRequest.Builder

setContent(ByteString value)

public RecognizeRequest.Builder setContent(ByteString value)

The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

bytes content = 5;

Parameter
Name Description
value ByteString

The content to set.
Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RecognizeRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecognizeRequest.Builder
Overrides

setRecognizer(String value)

public RecognizeRequest.Builder setRecognizer(String value)

Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

string recognizer = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The recognizer to set.
Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.

setRecognizerBytes(ByteString value)

public RecognizeRequest.Builder setRecognizerBytes(ByteString value)

Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

string recognizer = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for recognizer to set.
Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.

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

public RecognizeRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RecognizeRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RecognizeRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecognizeRequest.Builder
Overrides

setUri(String value)

public RecognizeRequest.Builder setUri(String value)

URI that points to a file that contains audio data bytes as specified in RecognitionConfig. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return INVALID_ARGUMENT). For more information, see Request URIs.

string uri = 6;

Parameter
Name Description
value String

The uri to set.
Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.

setUriBytes(ByteString value)

public RecognizeRequest.Builder setUriBytes(ByteString value)

URI that points to a file that contains audio data bytes as specified in RecognitionConfig. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return INVALID_ARGUMENT). For more information, see Request URIs.

string uri = 6;

Parameter
Name Description
value ByteString

The bytes for uri to set.
Returns
Type Description
RecognizeRequest.Builder

This builder for chaining.