Class BatchRecognizeRequest (4.37.0)

public final class BatchRecognizeRequest extends GeneratedMessageV3 implements BatchRecognizeRequestOrBuilder

Request message for the BatchRecognize method.

Protobuf type google.cloud.speech.v2.BatchRecognizeRequest

Static Fields

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CONFIG_MASK_FIELD_NUMBER

public static final int CONFIG_MASK_FIELD_NUMBER
Field Value
Type Description
int

FILES_FIELD_NUMBER

public static final int FILES_FIELD_NUMBER
Field Value
Type Description
int

PROCESSING_STRATEGY_FIELD_NUMBER

public static final int PROCESSING_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

RECOGNITION_OUTPUT_CONFIG_FIELD_NUMBER

public static final int RECOGNITION_OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RECOGNIZER_FIELD_NUMBER

public static final int RECOGNIZER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchRecognizeRequest getDefaultInstance()
Returns
Type Description
BatchRecognizeRequest

getDescriptor()

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

newBuilder()

public static BatchRecognizeRequest.Builder newBuilder()
Returns
Type Description
BatchRecognizeRequest.Builder

newBuilder(BatchRecognizeRequest prototype)

public static BatchRecognizeRequest.Builder newBuilder(BatchRecognizeRequest prototype)
Parameter
Name Description
prototype BatchRecognizeRequest
Returns
Type Description
BatchRecognizeRequest.Builder

parseDelimitedFrom(InputStream input)

public static BatchRecognizeRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchRecognizeRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BatchRecognizeRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchRecognizeRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchRecognizeRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchRecognizeRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchRecognizeRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchRecognizeRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BatchRecognizeRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchRecognizeRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BatchRecognizeRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchRecognizeRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchRecognizeRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BatchRecognizeRequest> parser()
Returns
Type Description
Parser<BatchRecognizeRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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 = 4;

Returns
Type Description
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 given 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 = 5;

Returns
Type Description
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 given 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 = 5;

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 = 4;

Returns
Type Description
RecognitionConfigOrBuilder

getDefaultInstanceForType()

public BatchRecognizeRequest getDefaultInstanceForType()
Returns
Type Description
BatchRecognizeRequest

getFiles(int index)

public BatchRecognizeFileMetadata getFiles(int index)

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 5.

repeated .google.cloud.speech.v2.BatchRecognizeFileMetadata files = 3;

Parameter
Name Description
index int
Returns
Type Description
BatchRecognizeFileMetadata

getFilesCount()

public int getFilesCount()

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 5.

repeated .google.cloud.speech.v2.BatchRecognizeFileMetadata files = 3;

Returns
Type Description
int

getFilesList()

public List<BatchRecognizeFileMetadata> getFilesList()

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 5.

repeated .google.cloud.speech.v2.BatchRecognizeFileMetadata files = 3;

Returns
Type Description
List<BatchRecognizeFileMetadata>

getFilesOrBuilder(int index)

public BatchRecognizeFileMetadataOrBuilder getFilesOrBuilder(int index)

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 5.

repeated .google.cloud.speech.v2.BatchRecognizeFileMetadata files = 3;

Parameter
Name Description
index int
Returns
Type Description
BatchRecognizeFileMetadataOrBuilder

getFilesOrBuilderList()

public List<? extends BatchRecognizeFileMetadataOrBuilder> getFilesOrBuilderList()

Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 5.

repeated .google.cloud.speech.v2.BatchRecognizeFileMetadata files = 3;

Returns
Type Description
List<? extends com.google.cloud.speech.v2.BatchRecognizeFileMetadataOrBuilder>

getParserForType()

public Parser<BatchRecognizeRequest> getParserForType()
Returns
Type Description
Parser<BatchRecognizeRequest>
Overrides

getProcessingStrategy()

public BatchRecognizeRequest.ProcessingStrategy getProcessingStrategy()

Processing strategy to use for this request.

.google.cloud.speech.v2.BatchRecognizeRequest.ProcessingStrategy processing_strategy = 7;

Returns
Type Description
BatchRecognizeRequest.ProcessingStrategy

The processingStrategy.

getProcessingStrategyValue()

public int getProcessingStrategyValue()

Processing strategy to use for this request.

.google.cloud.speech.v2.BatchRecognizeRequest.ProcessingStrategy processing_strategy = 7;

Returns
Type Description
int

The enum numeric value on the wire for processingStrategy.

getRecognitionOutputConfig()

public RecognitionOutputConfig getRecognitionOutputConfig()

Configuration options for where to output the transcripts of each file.

.google.cloud.speech.v2.RecognitionOutputConfig recognition_output_config = 6;

Returns
Type Description
RecognitionOutputConfig

The recognitionOutputConfig.

getRecognitionOutputConfigOrBuilder()

public RecognitionOutputConfigOrBuilder getRecognitionOutputConfigOrBuilder()

Configuration options for where to output the transcripts of each file.

.google.cloud.speech.v2.RecognitionOutputConfig recognition_output_config = 6;

Returns
Type Description
RecognitionOutputConfigOrBuilder

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 = 1 [(.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 = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for recognizer.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 = 4;

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 given 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 = 5;

Returns
Type Description
boolean

Whether the configMask field is set.

hasRecognitionOutputConfig()

public boolean hasRecognitionOutputConfig()

Configuration options for where to output the transcripts of each file.

.google.cloud.speech.v2.RecognitionOutputConfig recognition_output_config = 6;

Returns
Type Description
boolean

Whether the recognitionOutputConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BatchRecognizeRequest.Builder newBuilderForType()
Returns
Type Description
BatchRecognizeRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchRecognizeRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BatchRecognizeRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BatchRecognizeRequest.Builder toBuilder()
Returns
Type Description
BatchRecognizeRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException