Class RecognizeRequest (4.17.0)

public final class RecognizeRequest extends GeneratedMessageV3 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 Fields

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIG_MASK_FIELD_NUMBER

public static final int CONFIG_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
TypeDescription
int

RECOGNIZER_FIELD_NUMBER

public static final int RECOGNIZER_FIELD_NUMBER
Field Value
TypeDescription
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RecognizeRequest getDefaultInstance()
Returns
TypeDescription
RecognizeRequest

getDescriptor()

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

newBuilder()

public static RecognizeRequest.Builder newBuilder()
Returns
TypeDescription
RecognizeRequest.Builder

newBuilder(RecognizeRequest prototype)

public static RecognizeRequest.Builder newBuilder(RecognizeRequest prototype)
Parameter
NameDescription
prototypeRecognizeRequest
Returns
TypeDescription
RecognizeRequest.Builder

parseDelimitedFrom(InputStream input)

public static RecognizeRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognizeRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RecognizeRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RecognizeRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RecognizeRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RecognizeRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RecognizeRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognizeRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RecognizeRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecognizeRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RecognizeRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RecognizeRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecognizeRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RecognizeRequest> parser()
Returns
TypeDescription
Parser<RecognizeRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.

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.

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

getParserForType()

public Parser<RecognizeRequest> getParserForType()
Returns
TypeDescription
Parser<RecognizeRequest>
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RecognizeRequest.Builder newBuilderForType()
Returns
TypeDescription
RecognizeRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RecognizeRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RecognizeRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RecognizeRequest.Builder toBuilder()
Returns
TypeDescription
RecognizeRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException