Class RecognizeRequest.Builder (4.26.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RecognizeRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RecognizeRequest.Builder
Overrides

build()

public RecognizeRequest build()
Returns
TypeDescription
RecognizeRequest

buildPartial()

public RecognizeRequest buildPartial()
Returns
TypeDescription
RecognizeRequest

clear()

public RecognizeRequest.Builder clear()
Returns
TypeDescription
RecognizeRequest.Builder
Overrides

clearAudioSource()

public RecognizeRequest.Builder clearAudioSource()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
RecognizeRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RecognizeRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RecognizeRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RecognizeRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RecognizeRequest.Builder

This builder for chaining.

clone()

public RecognizeRequest.Builder clone()
Returns
TypeDescription
RecognizeRequest.Builder
Overrides

getAudioSourceCase()

public RecognizeRequest.AudioSourceCase getAudioSourceCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The content.

getDefaultInstanceForType()

public RecognizeRequest getDefaultInstanceForType()
Returns
TypeDescription
RecognizeRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the uri field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueRecognitionConfig
Returns
TypeDescription
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
NameDescription
valueFieldMask
Returns
TypeDescription
RecognizeRequest.Builder

mergeFrom(RecognizeRequest other)

public RecognizeRequest.Builder mergeFrom(RecognizeRequest other)
Parameter
NameDescription
otherRecognizeRequest
Returns
TypeDescription
RecognizeRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RecognizeRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognizeRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RecognizeRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RecognizeRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RecognizeRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueRecognitionConfig
Returns
TypeDescription
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
NameDescription
builderForValueRecognitionConfig.Builder
Returns
TypeDescription
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
NameDescription
valueFieldMask
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueByteString

The content to set.

Returns
TypeDescription
RecognizeRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RecognizeRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The recognizer to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for recognizer to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RecognizeRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RecognizeRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The uri to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
RecognizeRequest.Builder

This builder for chaining.